Struct Tree

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

A persistent, indexable, hierarchical data structure

See the module docs for more information

Implementations

impl<T: Clone> Tree<T>

pub fn new_with_root(value: T) -> Self

Create a new Tree with the specified root

pub fn insert( &mut self, value: T, location: Location, ) -> Result<NodeId, InvalidLocation>

Insert a new node at the specified location

Error if the location is invalid:

• The root node cannot have siblings
• The location must reference only existing nodes

pub fn root(&self) -> NodeRef<'_, T>

Get a reference to the root node

The tree will always have a root node

pub fn root_mut(&mut self) -> NodeMut<'_, T>

Get a mutable reference to the root node

The tree will always have a root node

pub fn get(&self, id: NodeId) -> Option<NodeRef<'_, T>>

Get a reference to the node with the specified ID

If there is no such node, returns None

pub fn get_mut(&mut self, id: NodeId) -> Option<NodeMut<'_, T>>

Get a mutable reference to the node with the specified ID

If there is no such node, returns None

pub fn iter_nodes(&self) -> impl Iterator<Item = NodeRef<'_, T>>

Iterate over all nodes in the Tree, in unspecified order

Trait Implementations

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

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.

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

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

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

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