Struct socarel::Tree

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

Struct that contains a tree.

Implementations

impl<T: NodeContent> Tree<T>

pub fn new() -> Self

Create new empty tree.

pub fn set_root(&mut self, node_content: &str) -> Option<usize>

Set root node.

Arguments

• content - Node content.

Return

• An Option with the root node index (always 0).

pub fn link_node(
    &mut self,
    node_content: &str,
    parent_node_index: usize
) -> Option<usize>

Create new node and link it to its parent.

Arguments

• node_content - Node content.
• parent_node_index - Parent node index.

Return

• An Option with the new node index.

pub fn get_node_content(&self, node_index: usize) -> Option<&T>

Get reference to node content.

Arguments

• node_index - Node index.

Return

• An Option with the node content reference.

pub fn update_node(
    &mut self,
    node_content: &str,
    node_index: usize
) -> Option<usize>

Overwrite node content. It must exist.

Arguments

• node_content - Node content.
• node_index - Node index.

Return

• An Option with the node index.

pub fn unlink_node(&mut self, node_index: usize) -> Option<usize>

Unlink node. It doesn’t remove node from the tree, it just disconnects it from parent.

This process is O(l) complexity, where l is the number of nodes of the same level of node_index.

Arguments

• node_index - Node index.

Return

• An Option with the node index.

pub fn find_node(&self, path: &[&str]) -> Option<usize>

Find node in the try by content.

The complexity of this operation is O(p), where p is the number of elements in the path.

Arguments

• path - Path of nodes, starting from root.

Return

• An Option with the node index.

pub fn iterators(&self) -> IterInterface<'_, T>

Get iterators interface.

Return

• Iterators interface.

pub fn get_nodes_ref(&self) -> &[Node<T>]

Get reference to nodes array.

Return

• Array reference.

pub fn get_nodes_len(&self) -> usize

Get size of nodes array.

Return

• Size.

Trait Implementations

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

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

Formats the value using the given formatter.