https://github.com/djugei/treelike
A trait to abstract over common tree functionality
https://github.com/djugei/treelike
datastructure rust trait tree
Last synced: about 1 year ago
JSON representation
A trait to abstract over common tree functionality
- Host: GitHub
- URL: https://github.com/djugei/treelike
- Owner: djugei
- License: apache-2.0
- Created: 2019-06-29T17:29:51.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2020-01-02T23:57:02.000Z (over 6 years ago)
- Last Synced: 2024-04-26T00:42:27.515Z (about 2 years ago)
- Topics: datastructure, rust, trait, tree
- Language: Rust
- Size: 71.3 KB
- Stars: 34
- Watchers: 3
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Treelike
This crate tries to provide a common trait for all kinds of trees. Two reasons for that:
## Interoperability
Using a common trait allows third parties to switch tree implementations seamlessly. It also
enables further abstractions to be built over for trees.
## Automation
If you are implementing a tree, `Treelike` only requires you to implement two methods on
your nodes, `content` to return its contents and `children` to list its children.
Many kinds of traversals and searches are then provided for free. I found myself implementing
the same methods over and over on different trees, so that is my main motivation.
# no_std
This crate tries to stay no_std compatible, but provides more functionality if allocations are
available. The relevant types and methods contain a no_std section to discuss functionality and
limitations.
# Contributing
Please symlink the hooks to your local .git/hooks/ directory to run some automatic checks before committing.
ln -s ../../hooks/pre-commit .git/hooks/
Please install rustfmt and cargo-sync-readme so these checks can be run.
rustup component add rustfmt
cargo install cargo-sync-readme
Please execute `cargo-sync-readme` when you change the top-level-documentation.
Please run `cargo fmt` whenever you change code. If possible configure your editor to do so for you.