Struct TreeBuilder

pub struct TreeBuilder<T> { /* private fields */ }

A Tree builder. Provides more control over how a Tree is created.

Implementations

impl<T> TreeBuilder<T>

pub fn new() -> TreeBuilder<T>

Creates a new TreeBuilder with the default settings.

use slab_tree::tree::TreeBuilder;

let _tree_builder = TreeBuilder::new();

Examples found in repository

examples/basic.rs (line 14)

fn main() {
    //      "hello"
    //        / \
    // "world"   "trees"
    //              |
    //            "are"
    //              |
    //            "cool"

    let mut tree = TreeBuilder::new().with_root("hello").build();
    let root_id = tree.root_id().expect("root doesn't exist?");
    let mut hello = tree.get_mut(root_id).unwrap();

    hello.append("world");
    hello.append("trees").append("are").append("cool");
}

examples/formatted.rs (line 6)

fn main() {
    let mut tree = TreeBuilder::new().with_root(0).build();
    let mut root = tree.root_mut().unwrap();
    {
        let mut one = root.append(1);
        let mut two = one.append(2);
        two.append(3);
        two.append(4);
    }
    {
        let mut five = root.append(5);
        five.append(6).append(7);
        five.append(8);
    }
    root.append(9);

    let mut s = String::new();
    // 0
    // ├── 1
    // │   └── 2
    // │       ├── 3
    // │       └── 4
    // ├── 5
    // │   ├── 6
    // │   │   └── 7
    // │   └── 8
    // └── 9
    tree.write_formatted(&mut s).unwrap();
    print!("{}", s);
}

pub fn with_root(self, root: T) -> TreeBuilder<T>

Sets the root Node of the TreeBuilder.

use slab_tree::tree::TreeBuilder;

let _tree_builder = TreeBuilder::new().with_root(1);

Examples found in repository

examples/basic.rs (line 14)

fn main() {
    //      "hello"
    //        / \
    // "world"   "trees"
    //              |
    //            "are"
    //              |
    //            "cool"

    let mut tree = TreeBuilder::new().with_root("hello").build();
    let root_id = tree.root_id().expect("root doesn't exist?");
    let mut hello = tree.get_mut(root_id).unwrap();

    hello.append("world");
    hello.append("trees").append("are").append("cool");
}

examples/formatted.rs (line 6)

fn main() {
    let mut tree = TreeBuilder::new().with_root(0).build();
    let mut root = tree.root_mut().unwrap();
    {
        let mut one = root.append(1);
        let mut two = one.append(2);
        two.append(3);
        two.append(4);
    }
    {
        let mut five = root.append(5);
        five.append(6).append(7);
        five.append(8);
    }
    root.append(9);

    let mut s = String::new();
    // 0
    // ├── 1
    // │   └── 2
    // │       ├── 3
    // │       └── 4
    // ├── 5
    // │   ├── 6
    // │   │   └── 7
    // │   └── 8
    // └── 9
    tree.write_formatted(&mut s).unwrap();
    print!("{}", s);
}

pub fn with_capacity(self, capacity: usize) -> TreeBuilder<T>

Sets the capacity of the TreeBuilder.

This can be used to pre-allocate space in the Tree if you know you’ll be adding a large number of Nodes to the Tree.

use slab_tree::tree::TreeBuilder;

let _tree_builder = TreeBuilder::new().with_capacity(10);

pub fn build(self) -> Tree<T>

Build a Tree based upon the current settings in the TreeBuilder.

use slab_tree::tree::TreeBuilder;

let _tree = TreeBuilder::new().with_root(1).with_capacity(10).build();

Examples found in repository

examples/basic.rs (line 14)

fn main() {
    //      "hello"
    //        / \
    // "world"   "trees"
    //              |
    //            "are"
    //              |
    //            "cool"

    let mut tree = TreeBuilder::new().with_root("hello").build();
    let root_id = tree.root_id().expect("root doesn't exist?");
    let mut hello = tree.get_mut(root_id).unwrap();

    hello.append("world");
    hello.append("trees").append("are").append("cool");
}

examples/formatted.rs (line 6)

fn main() {
    let mut tree = TreeBuilder::new().with_root(0).build();
    let mut root = tree.root_mut().unwrap();
    {
        let mut one = root.append(1);
        let mut two = one.append(2);
        two.append(3);
        two.append(4);
    }
    {
        let mut five = root.append(5);
        five.append(6).append(7);
        five.append(8);
    }
    root.append(9);

    let mut s = String::new();
    // 0
    // ├── 1
    // │   └── 2
    // │       ├── 3
    // │       └── 4
    // ├── 5
    // │   ├── 6
    // │   │   └── 7
    // │   └── 8
    // └── 9
    tree.write_formatted(&mut s).unwrap();
    print!("{}", s);
}

Trait Implementations

impl<T> Default for TreeBuilder<T>

fn default() -> Self

Returns the “default value” for a type.