arbutus 0.1.5

Arbutus Trees
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61

## Arbutus

Arbutus is a tree data structure library for Rust.

### Overview

Arbutus provides a high-level API for constructing and manipulating trees, along with support for indexing and querying. The library focuses on simplicity, flexibility, and performance.

### Features

*   **Tree Construction**: Build trees using the `TreeBuilder` API, which provides a composable way to construct tree structures.
*   **Indexing**: Utilize B-Tree indices for efficient querying and retrieval of node data.
*   **Iterators**: Traverse trees using iterators

### Getting Started

To get started with Arbutus, add the following dependency to your `Cargo.toml` file:

```toml
[dependencies]
arbutus = "0.1.0"
```

Example of building a tree

```rust
// Custom errors can be propagated through the builder closures
#[derive(Debug)]
enum MyError {
    Fail(String),
}

#[derive(Debug)]
enum TestData {
    Foo,
    Bar,
    String(String),
    Baz,
}

let tree = TreeBuilder::<TestData, MyError>::new()
    .root(TestData::Foo, |foo| {
        debug!("Foo builder closure");

        foo.child(TestData::Bar, |bar| {
            debug!("Bar builder closure");
            bar.child(TestData::Baz, |_| Ok(()))
        })?;

        foo.child(TestData::String("Hello".into()), |_| Ok(()))?;

        Ok(())
    })
    .unwrap()
    .done();
info!("{tree:#?}");
```

### License

Arbutus is released under the MIT license. See the [LICENSE](LICENSE.txt) file for details.