[][src]Struct read_tree::Tree

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

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.


impl<T> Tree<T>[src]

pub fn as_node(&self) -> Node<T>[src]

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>>[src]

Returns the node with the specified rank.

pub fn len(&self) -> usize[src]

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>[src]

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>[src]

Auto Trait Implementations

impl<T> Send for Tree<T> where
    T: Send

impl<T> Sync for Tree<T> where
    T: Sync

impl<T> Unpin for Tree<T> where
    T: Unpin

impl<T> UnwindSafe for Tree<T> where
    T: UnwindSafe

impl<T> RefUnwindSafe for Tree<T> where
    T: RefUnwindSafe

Blanket Implementations

impl<T, U> Into<U> for T where
    U: From<T>, 

impl<T> From<T> for T[src]

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

impl<T> Borrow<T> for T where
    T: ?Sized

impl<T> BorrowMut<T> for T where
    T: ?Sized

impl<T> Any for T where
    T: 'static + ?Sized