[][src]Struct read_tree::PolyTree

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

A read-only poly-tree data structure.

Similar to Tree<T> but allows multiple root nodes.

Methods

impl<T> PolyTree<T>[src]

Important traits for Children<'a, T>
pub fn roots(&self) -> Children<T>[src]

Returns an iterator over the root nodes of the poly-tree.

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 poly-tree.

Because poly-trees are required to not be empty, the length will always be at least 1.

pub fn into_sapling(self) -> Sapling<T>[src]

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

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

Trait Implementations

impl<T: Debug> Debug for PolyTree<T>[src]

Auto Trait Implementations

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

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

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

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

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

Blanket Implementations

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

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

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

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

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

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