Struct Tree

pub struct Tree<T>
where
    T: Display + PartialEq + Clone,
{ /* private fields */ }

A Tree structure which contains elements that are also trees?

Note: the paraemter T requires some trait boundaries:

• std::fmt::Display
• std::clone::Clone
• std::cmp::PartialEq

Implementations

impl<T> Tree<T>

where T: Display + PartialEq + Clone,

pub fn new(name: T) -> Tree<T>

Creates a new structure where name parameter will be the name element of the tree. The sub-tree will initial with empty.

Examples found in repository

examples/atree.rs (line 8)

fn main() {
    let mut root = MyTree::new("root".to_string());
    let mut s1 = MyTree::new("s1".to_string());
    let mut s1_s1 = MyTree::new("s1_s1".to_string());
    let s1_s1_s1 = MyTree::new("s1_s1_s1".to_string());
    let s1_s1_s2 = MyTree::new("s1_s1_s2".to_string());
    let s1_s2 = MyTree::new("s1_s2".to_string());
    let s1_s3 = MyTree::new("s1_s3".to_string());
    s1_s1.add(s1_s1_s1);
    s1_s1.add(s1_s1_s2);
    s1.add(s1_s1);
    s1.add(s1_s2);
    s1.add(s1_s3);

    let s2 = MyTree::new("s2".to_string());
    root.add(s1);
    root.add(s2);

    let printer = tree::TreePrinter::new();
    printer.print(&root);

    for e in &root {
        println!("{}", e);
    }


    let e = ["root", "s1", "s1_s1"].iter().map(|x| x.to_string()).collect();
    let p = tree::Path::from(e);

    let r = root.remove(&p);

    if r {
        println!("It has been removed!");
    } else {
        println!("Nothing has been removed!");
    }

    printer.print(&root);
}

pub fn set_root(&mut self, is_root: bool)

Sets the Tree as root of the tree structure

pub fn name(&self) -> &T

Return the name of the element

pub fn name_mut(&mut self) -> &mut T

Return the name of the element

pub fn add(&mut self, sub: Tree<T>)

Adds a node to the tree where the note is of type Tree<T>.

Examples found in repository

examples/atree.rs (line 15)

fn main() {
    let mut root = MyTree::new("root".to_string());
    let mut s1 = MyTree::new("s1".to_string());
    let mut s1_s1 = MyTree::new("s1_s1".to_string());
    let s1_s1_s1 = MyTree::new("s1_s1_s1".to_string());
    let s1_s1_s2 = MyTree::new("s1_s1_s2".to_string());
    let s1_s2 = MyTree::new("s1_s2".to_string());
    let s1_s3 = MyTree::new("s1_s3".to_string());
    s1_s1.add(s1_s1_s1);
    s1_s1.add(s1_s1_s2);
    s1.add(s1_s1);
    s1.add(s1_s2);
    s1.add(s1_s3);

    let s2 = MyTree::new("s2".to_string());
    root.add(s1);
    root.add(s2);

    let printer = tree::TreePrinter::new();
    printer.print(&root);

    for e in &root {
        println!("{}", e);
    }


    let e = ["root", "s1", "s1_s1"].iter().map(|x| x.to_string()).collect();
    let p = tree::Path::from(e);

    let r = root.remove(&p);

    if r {
        println!("It has been removed!");
    } else {
        println!("Nothing has been removed!");
    }

    printer.print(&root);
}

pub fn is_leaf(&self) -> bool

pub fn remove(&mut self, path: &Path<T>) -> bool

Remove an element from the Tree as specified by the path. Returns true if the element has been found and removed.

Examples found in repository

examples/atree.rs (line 36)

fn main() {
    let mut root = MyTree::new("root".to_string());
    let mut s1 = MyTree::new("s1".to_string());
    let mut s1_s1 = MyTree::new("s1_s1".to_string());
    let s1_s1_s1 = MyTree::new("s1_s1_s1".to_string());
    let s1_s1_s2 = MyTree::new("s1_s1_s2".to_string());
    let s1_s2 = MyTree::new("s1_s2".to_string());
    let s1_s3 = MyTree::new("s1_s3".to_string());
    s1_s1.add(s1_s1_s1);
    s1_s1.add(s1_s1_s2);
    s1.add(s1_s1);
    s1.add(s1_s2);
    s1.add(s1_s3);

    let s2 = MyTree::new("s2".to_string());
    root.add(s1);
    root.add(s2);

    let printer = tree::TreePrinter::new();
    printer.print(&root);

    for e in &root {
        println!("{}", e);
    }


    let e = ["root", "s1", "s1_s1"].iter().map(|x| x.to_string()).collect();
    let p = tree::Path::from(e);

    let r = root.remove(&p);

    if r {
        println!("It has been removed!");
    } else {
        println!("Nothing has been removed!");
    }

    printer.print(&root);
}

pub fn get_entry_from_path<'a>(&'a self, path: &Path<T>) -> Option<&'a Tree<T>>

Gets an Entry (Tree<T>) from a given path.

Trait Implementations

impl<T> Debug for Tree<T>

where T: Display + PartialEq + Clone + Debug,

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

Formats the value using the given formatter.

impl<T> Default for Tree<T>

where T: Display + PartialEq + Clone + Default,

fn default() -> Tree<T>

Returns the “default value” for a type.

impl<T> Display for Tree<T>

where T: Display + PartialEq + Clone,

Display implementation for the tree

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

Formats the value using the given formatter.

impl<'a, T> IntoIterator for &'a Tree<T>

where T: Display + PartialEq + Clone,

non-consuming version IntoIterator trait implementation for the Tree<T>.

type Item = Path<T>

The type of the elements being iterated over.

type IntoIter = TreeIterator<T>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.