Struct socarel::Forest

pub struct Forest<T: NodeContent = RawNode> { /* fields omitted */ }

A forest is a set of trees.

Implementations

impl<T: NodeContent> Forest<T>

pub fn new() -> Self

Create an empty forest.

pub fn new_tree(&mut self, name: &str)

Create new empty tree.

Arguments

• name - Tree name.

Return

• Nothing.

pub fn add_tree(&mut self, name: &str, tree: Tree<T>)

Add a tree to forest.

Arguments

• name - Tree name.
• forest - Tree struct.

Return

• Nothing.

pub fn remove_tree(&mut self, name: &str) -> Option<Tree<T>>

Remove tree from the forest.

Arguments

• name - Tree name.

Return

• An Option with the removed tree.

pub fn get_tree(&self, name: &str) -> Option<&Tree<T>>

Get tree reference.

Arguments

• name - Tree name.

Return

• An Option with the tree reference.

pub fn get_mut_tree(&mut self, name: &str) -> Option<&mut Tree<T>>

Get mutable tree reference.

Arguments

• name - Tree name.

Return

• An Option with the mut tree reference.

pub fn iter(&self) -> Iter<'_, String, Tree<T>>

Get forest iterator.

Return

• Iterator, provides a tuple with tree_name<String>, tree_struct<Tree>.

Trait Implementations

impl<T: Debug + NodeContent> Debug for Forest<T>

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

Formats the value using the given formatter.