Awesome
orange-trees
<p align="center"> <img src="docs/images/orange-trees.svg" width="256" height="256" /> </p> <p align="center">~ A tree data structure implementation in Rust ~</p> <p align="center">Developed by <a href="https://veeso.github.io/" target="_blank">@veeso</a></p> <p align="center">Current version: 0.1.0 (09/06/2021)</p> <p align="center"> <a href="https://opensource.org/licenses/MIT" ><img src="https://img.shields.io/badge/License-MIT-teal.svg" alt="License-MIT" /></a> <a href="https://github.com/veeso/orange-trees/stargazers" ><img src="https://img.shields.io/github/stars/veeso/orange-trees.svg" alt="Repo stars" /></a> <a href="https://crates.io/crates/orange-trees" ><img src="https://img.shields.io/crates/d/orange-trees.svg" alt="Downloads counter" /></a> <a href="https://crates.io/crates/orange-trees" ><img src="https://img.shields.io/crates/v/orange-trees.svg" alt="Latest version" /></a> <a href="https://ko-fi.com/veeso"> <img src="https://img.shields.io/badge/donate-ko--fi-red" alt="Ko-fi" /></a> </p> <p align="center"> <a href="https://github.com/veeso/orange-trees/actions" ><img src="https://github.com/veeso/orange-trees/workflows/Linux/badge.svg" alt="Linux CI" /></a> <a href="https://github.com/veeso/orange-trees/actions" ><img src="https://github.com/veeso/orange-trees/workflows/MacOS/badge.svg" alt="MacOS CI" /></a> <a href="https://github.com/veeso/orange-trees/actions" ><img src="https://github.com/veeso/orange-trees/workflows/Windows/badge.svg" alt="Windows CI" /></a> <a href="https://coveralls.io/github/veeso/orange-trees" ><img src="https://coveralls.io/repos/github/veeso/orange-trees/badge.svg" alt="Coveralls" /></a> <a href="https://docs.rs/orange-trees" ><img src="https://docs.rs/orange-trees/badge.svg" alt="Docs" /></a> </p>About orange-trees 🍊
Flowers in my hair, I belong by the sea
Where we used to be, sitting by the orange trees
~ Orange Trees - Marina ~
orange-trees is an implementation of the Tree data structure. It comes with a rich set of methods to manipulate and query nodes. In orange-trees each Tree is represented by a Node, where each Node has a Key, which identify the node, a Value and a list of children, which are nodes too. Key and value are defined by the user, since they are generics.
#[macro_use]
extern crate orange_trees;
use orange_trees::{Tree, Node};
// Create a tree using macro
let tree: Tree<&'static str, &'static str> = Tree::new(
node!("/", "/"
, node!("/bin", "bin/"
, node!("/bin/ls", "ls")
, node!("/bin/pwd", "pwd")
)
, node!("/tmp", "tmp/"
, node!("/tmp/dump.txt", "dump.txt")
, node!("/tmp/omar.txt", "omar.txt")
)
)
);
// Create a tree using constructor
let tree: Tree<&'static str, &'static str> = Tree::new(
Node::new("/", "/")
.with_child(
Node::new("/bin", "bin/")
.with_child(Node::new("/bin/ls", "ls"))
.with_child(Node::new("/bin/pwd", "pwd"))
)
.with_child(
Node::new("/tmp", "tmp/")
.with_child(Node::new("/tmp/dump.txt", "dump.txt"))
.with_child(Node::new("/tmp/omar.txt", "omar.txt"))
.with_child(
Node::new("/tmp/.cache", "cache/")
.with_child(Node::new("/tmp/.cache/xyz.cache", "xyz.cache"))
)
),
);
Get started 🏁
Add orange-trees to your Cargo.toml 🦀
orange-trees = "0.1.0"
Examples
Examples can be found in the homepage of the documentation at https://docs.rs/orange-trees
Contributing and issues 🤝🏻
Contributions, bug reports, new features and questions are welcome! 😉 If you have any question or concern, or you want to suggest a new feature, or you want just want to improve orange-trees, feel free to open an issue or a PR.
Please follow our contributing guidelines
Changelog ⏳
View orange-trees's changelog HERE
Buy me a coffee ☕
If you like orange-trees and you're grateful for the work I've done, please consider a little donation 🥳
You can make a donation with one of these platforms:
License 📃
orange-trees is licensed under the MIT license.
You can read the entire license HERE