Struct simple_tree::Tree

pub struct Tree<T: Clone> { /* fields omitted */ }

Stores all data and relationships between nodes

Methods

impl<T: Clone> Tree<T>

pub fn new() -> Self

Returns a new empty tree

pub fn is_valid(&self, node: NodeID) -> bool

Check if a node id points to a valid, non-deleted node in the tree. Returns true if the node id is valid.

Arguments

• node - the NodeID to check

pub fn delete(&mut self, node: NodeID) -> usize

Mark a node in the tree, and all of its children as invalid. This allows the reuse of these indexes by other nodes created later. Returns the number of total nodes that were deleted.

pub fn add_root(&mut self, val: T) -> NodeID

Add a root node and return its id

pub fn get(&self, node: NodeID) -> Option<&T>

Returns the value for a node (if it exists)

pub fn get_mut(&mut self, node: NodeID) -> Option<&mut T>

Returns the mutable value for a node (if it exists)

pub fn get_unchecked(&self, node: NodeID) -> &T

Returns the value for a node, and panic if it doesn't exist

pub fn get_unchecked_mut(&mut self, node: NodeID) -> &mut T

Returns the mutable value for a node, and panic if it doesn't exist

pub fn set(&mut self, node: NodeID, val: T)

Set the value for a node (if it already exists)

pub fn add_child(&mut self, node: NodeID, val: T) -> Option<NodeID>

Add a child to the node and return its id (if successful)

pub fn add_child_unchecked(&mut self, node: NodeID, val: T) -> NodeID

Add a child to the node and return its id. Panics if node does not exist

pub fn children_ids_unchecked(&self, node: NodeID) -> &Vec<NodeID>

Returns the children_ids for a node Panics if the node doesn't exist

pub fn root_ids(&self) -> &Vec<NodeID>

Returns the root nodes of the tree

pub fn parent_id(&self, node: NodeID) -> Option<NodeID>

Returns the parent id for the node

Important traits for DepthIter<'a, T>

impl<'a, T: Clone> Iterator for DepthIter<'a, T> type Item = Node<'a, T>;

pub fn iter_depth(&self) -> DepthIter<T>

Returns a depth-first iterator This iterates a single node until a leaf is reached and then moves onto the next one

Important traits for BreadthIter<'a, T>

impl<'a, T: Clone> Iterator for BreadthIter<'a, T> type Item = Node<'a, T>;

pub fn iter_breadth(&self) -> BreadthIter<T>

Returns a breadth-first iterator This iterates an entire depth-level before moving onto the next deepest nodes

pub fn path(&self, node: NodeID) -> Vec<NodeID>

Returns the node sequence from a root node to the given node

pub fn path_values_ref(&self, node: NodeID) -> Vec<&T>

Returns references to values in the node sequence from a root node to the given node

pub fn path_values(&self, node: NodeID) -> Vec<T>

Returns cloned values in the node sequence from a root node to the given node

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: Eq + Clone> Eq for Tree<T>

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

fn eq(&self, other: &Tree<T>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Tree<T>) -> bool

This method tests for !=.

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

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