Struct ego_tree::Tree

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

A Vec-backed tree.

Nodes are allocated in a Vec which is only ever pushed to. NodeId is an opaque index into the Vec.

Each Tree has a unique ID which is also given to each NodeId it creates. This is used to bounds check a NodeId.

Methods

impl<T> Tree<T>

fn values(&self) -> Values<T>

Returns an iterator over node values in creation order.

fn values_mut(&mut self) -> ValuesMut<T>

Returns a mutable iterator over node values in creation order.

fn into_values(self) -> IntoValues<T>

Returns an iterator that moves node values out of the tree in creation order.

fn nodes(&self) -> Nodes<T>

Returns an iterator over all nodes, including orphans, in creation order.

impl<T> Tree<T>

fn new(root: T) -> Self

Creates a new tree with a root node.

fn with_capacity(root: T, capacity: usize) -> Self

Creates a new tree of the specified capacity with a root node.

fn root(&self) -> NodeRef<T>

Returns a reference to the root node.

fn root_mut(&mut self) -> NodeMut<T>

Returns a mutator of the root node.

fn orphan(&mut self, value: T) -> NodeMut<T>

Creates an orphan node, returning a mutator of it.

fn get(&self, id: NodeId<T>) -> NodeRef<T>

Returns a reference to the specified node.

Panics

Panics if id does not refer to a node in this tree.

fn get_mut(&mut self, id: NodeId<T>) -> NodeMut<T>

Returns a mutator of the specified node.

Panics

Panics if id does not refer to a node in this tree.

Trait Implementations

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

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

Formats the value using the given formatter.

impl<T: Default> Default for Tree<T>

fn default() -> Self

Returns the "default value" for a type.

impl<T: Clone> Clone for Tree<T>

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T: Eq> Eq for Tree<T>

impl<T: PartialEq> PartialEq for Tree<T>

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=.