Struct easy_tree::Tree

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

A tree structure containing nodes.

Implementations

impl<T> Tree<T>

pub fn new() -> Self

Creates a new empty tree.

pub fn add_node(&mut self, data: T) -> usize

Adds a new node with the given data to the tree and returns its index. The nodes added with this method will be disconnected from the tree, so use it only for the root node. For adding children, use the add_child method.

pub fn add_child(&mut self, parent: usize, data: T) -> usize

Adds a child node with the given data to the specified parent node and returns the child’s index.

pub fn add_child_to_root(&mut self, data: T) -> usize

Adds a child node with the given data to the root node and returns the child’s index.

pub fn get(&self, index: usize) -> Option<&T>

Returns a reference to the data of the node at the given index, or None if the index is out of bounds.

pub fn get_unchecked(&self, index: usize) -> &T

Returns a reference to the data of the node at the given index without bounds checking.

pub fn get_mut(&mut self, index: usize) -> Option<&mut T>

Returns a mutable reference to the data of the node at the given index, or None if the index is out of bounds.

pub fn get_unchecked_mut(&mut self, index: usize) -> &mut T

Returns a mutable reference to the data of the node at the given index without bounds checking.

pub fn parent_index_unchecked(&self, index: usize) -> Option<usize>

Returns the index of the parent node of the node at the given index, or None if the node has no parent.

pub fn children(&self, index: usize) -> &[usize]

Returns a slice of the indices of the children of the node at the given index.

pub fn traverse<'a, S>( &'a self, before_processing_children: impl FnMut(usize, &'a T, &mut S), after_processing_the_subtree: impl FnMut(usize, &'a T, &mut S), s: &mut S, )

Walks the tree recursively, applying the given functions before and after processing the children of each node.

pub fn iter(&self) -> impl Iterator<Item = (usize, &T)>

Returns an iterator over the indices and data of the nodes in the tree.

pub fn iter_mut(&mut self) -> impl Iterator<Item = (usize, &mut T)>

Returns a mutable iterator over the indices and data of the nodes in the tree.

pub fn is_empty(&self) -> bool

Returns true if the tree contains no nodes.

pub fn len(&self) -> usize

Returns the number of nodes in the tree.

pub fn clear(&mut self)

Removes all nodes from the tree.

impl<T: Send + Sync> Tree<T>

pub fn par_iter(&self) -> impl ParallelIterator<Item = (usize, &T)>

Returns a parallel iterator over the indices and data of the nodes in the tree.

pub fn par_iter_mut(&mut self) -> impl ParallelIterator<Item = (usize, &mut T)>

Returns a mutable parallel iterator over the indices and data of the nodes in the tree.

Trait Implementations

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

fn clone(&self) -> Tree<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> Default for Tree<T>

fn default() -> Self

Returns the “default value” for a type.