Struct tref::TreeModel

pub struct TreeModel<'a, T: NodeContent> {
    pub tree_ref: &'a Tree<T>,
    pub level_ref: Option<&'a Vec<TreeLevel>>,
}

Struct that represents a tree.

Fields

tree_ref: &'a Tree<T>

Reference to the tree structure, contained in the Forest.

level_ref: Option<&'a Vec<TreeLevel>>

Reference to the tree levels structure, contained in the Forest.

Implementations

impl<'a, 'b, T: NodeContent> TreeModel<'a, T>

pub fn new(forest: &'a Forest<T>, tree_id: &str) -> Option<Self>

Create a new tree model.

Arguments

• forest - A Forest structure
• tree_id - ID of the tree.

Return

• An Option with the tree model.

pub fn iter(&'b self) -> TreeIter<'a, 'b, T>

Create an iterator using simple traversal.

It traverses the node array from the first position to the last, ignoring the tree structure.

The iterator returns instances of TreeNode.

Examples

let forest = ... // Obtain a Forest structure
if let Some(tree_model) = forest.tree("my_tree") {
    for (n, _) in tree_model.iter() {
        println!("{}", n.content.get_content());
    }
}

pub fn inv_iter(&'b self) -> InvTreeIter<'a, 'b, T>

Create an iterator using simple inverse traversal.

It traverses the node array from the last position to the first, ignoring the tree structure.

Examples

Check iter(), all iterators work the same way.

pub fn bfs_iter(&'b self) -> BfsIterSwitch<'a, 'b, T>

Create an iterator using the BFS algorithm.

Examples

Check iter(), all iterators work the same way.

pub fn inv_bfs_iter(&'b self) -> InvBfsIterSwitch<'a, 'b, T>

Create an iterator using the Inverse BFS algorithm.

Examples

Check iter(), all iterators work the same way.

pub fn inv_lev_bfs_iter(&'b self) -> InvLevBfsIter<'a, 'b, T>

Create an iterator using the Inverse Levels BFS algorithm. Only available if using the levels structure.

Examples

Check iter(), all iterators work the same way.

pub fn pre_dfs_iter(&'b self) -> PreDfsIter<'a, 'b, T>

Create an iterator using the Pre-DFS algorithm.

Examples

Check iter(), all iterators work the same way.

pub fn inv_pre_dfs_iter(&'b self) -> InvPreDfsIter<'a, 'b, T>

Create an iterator using the Inverse Pre-DFS algorithm.

Examples

Check iter(), all iterators work the same way.

pub fn post_dfs_iter(&'b self) -> PostDfsIter<'a, 'b, T>

Create an iterator using the Post-DFS algorithm.

Examples

Check iter(), all iterators work the same way.

pub fn inv_post_dfs_iter(&'b self) -> InvPostDfsIter<'a, 'b, T>

Create an iterator using the Inverse Post-DFS algorithm.

Examples

Check iter(), all iterators work the same way.

Trait Implementations

impl<'a, T: Debug + NodeContent> Debug for TreeModel<'a, T>

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

Formats the value using the given formatter.