Struct Tree

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

A read-only tree data structure.

Trees are created from Sapling<T>s. Most interactions with trees happen on slices of them called Nodes. Get a node representing the entire tree using as_node.

Implementations

impl<T> Tree<T>

pub fn as_node(&self) -> Node<'_, T>

Returns the unique root node of the tree representing the entire tree.

You can think of this as taking the complete slice of the tree similar to &vec[..] for a Vec<T>.

pub fn get(&self, rank: usize) -> Option<Node<'_, T>>

Returns the node with the specified rank.

pub fn len(&self) -> usize

Returns the number of nodes in the tree.

Because trees are required to have exactly one root node, the length will always be at least 1.

pub fn into_sapling(self) -> Sapling<T>

Turns the tree back into a sapling. No nodes are removed from the tree; building the returned sapling will result in the original tree.

All internal buffers are reused, making this a cheap operation. The only cost of converting Sapling<T>s and Tree<T>s back and forth is the validation that occurs during build.

Trait Implementations

impl<T: Debug> Debug for Tree<T>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.