Struct tree_iterators_rs::prelude::TreeNode

pub struct TreeNode<T> {
    pub value: T,
    pub children: Option<Vec<TreeNode<T>>>,
}

A default implemenation of a tree node. This struct provides a series of tree traversal utilities to allow you to easily work with and modify arbitrary trees.

Fields

value: T

This node’s value

children: Option<Vec<TreeNode<T>>>

The children of the current node.

Trait Implementations

impl<'a, T> BorrowedTreeNode<'a> for TreeNode<T>

where T: 'a,

fn get_value_and_children_iter( &'a self ) -> (Self::BorrowedValue, Option<Self::BorrowedChildren>)

This method gets the value and children from this node. The other methods of this trait assume that the ‘Children’ list does not contain any circular references. If there are, an infinite loop will result.

type BorrowedValue = &'a T

A reference to the value of each node in the tree.

type BorrowedChildren = Iter<'a, TreeNode<T>>

The type of iterator that can be used to iterate over each node’s children collection.

fn bfs_iter(&'a self) -> impl TreeIterator<Item = Self::BorrowedValue>

This method retrieves an iterator that can be used to perform Breadth First (Queue - specifically VecDeque-based) searches of a tree.

fn dfs_preorder_iter(&'a self) -> impl TreeIterator<Item = Self::BorrowedValue>

This method retrieves an iterator that can be used to perform Depth First Preorder searches of a tree.

fn dfs_postorder_iter(&'a self) -> impl TreeIterator<Item = Self::BorrowedValue>

This method retrieves an iterator that can be used to perform Depth First Postorder searches of a tree.

impl<T: Clone> Clone for TreeNode<T>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for TreeNode<T>

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

Formats the value using the given formatter.

impl<T: Default> Default for TreeNode<T>

fn default() -> TreeNode<T>

Returns the “default value” for a type.

impl<'a, T> MutBorrowedTreeNode<'a> for TreeNode<T>

where T: 'a,

fn get_value_and_children_iter_mut( &'a mut self ) -> (Self::MutBorrowedValue, Option<Self::MutBorrowedChildren>)

This method gets the value and children from this node. The other methods of this trait assume that the ‘Children’ list does not contain any circular references. If there are, an infinite loop will result.

type MutBorrowedValue = &'a mut T

A mutable reference to the value of each node in the tree.

type MutBorrowedChildren = IterMut<'a, TreeNode<T>>

The type of iterator that can be used to iterate over each node’s children collection.

fn bfs_iter_mut( &'a mut self ) -> impl TreeIteratorMut<Item = Self::MutBorrowedValue>

This method retrieves an iterator that can be used to perform Breadth First (VecDeque-based) searches of a tree.

fn dfs_preorder_iter_mut( &'a mut self ) -> impl TreeIteratorMut<Item = Self::MutBorrowedValue>

This method retrieves an iterator that can be used to perform Depth First Preorder searches of a tree.

fn dfs_postorder_iter_mut( &'a mut self ) -> impl TreeIteratorMut<Item = Self::MutBorrowedValue>

This method retrieves an iterator that can be used to perform Depth First Postorder searches of a tree.

impl<T> OwnedTreeNode for TreeNode<T>

fn get_value_and_children( self ) -> (Self::OwnedValue, Option<Self::OwnedChildren>)

This method gets the value and children from this node. The other methods of this trait assume that the ‘Children’ list does not contain any circular references. If there are, an infinite loop will result.

type OwnedValue = T

The value of each node in the tree.

type OwnedChildren = IntoIter<TreeNode<T>>

The type of iterator that can be used to iterate over each node’s children collection.

fn bfs(self) -> impl TreeIteratorMut<Item = Self::OwnedValue>

This method retrieves an iterator that can be used to perform Breadth First (Queue - specifically VecDeque-based) searches of a tree.

fn dfs_preorder(self) -> impl TreeIteratorMut<Item = Self::OwnedValue>

This method retrieves an iterator that can be used to perform Depth First Preorder searches of a tree.

fn dfs_postorder(self) -> impl TreeIteratorMut<Item = Self::OwnedValue>

This method retrieves an iterator that can be used to perform Depth First Postorder searches of a tree.