Struct Tree 

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

Vec-backed ID-tree.

Always contains at least a root node.

Implementations

impl<T> Tree<T>

pub fn new(root: T) -> Tree<T>

Creates a tree with a root node.

pub fn with_capacity(root: T, capacity: usize) -> Tree<T>

Creates a tree with a root node and the specified capacity.

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

Returns a reference to the specified node.

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

Returns a mutator of the specified node.

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

Returns a reference to the specified node.

Safety

The caller must ensure that id is a valid node ID.

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

Returns a mutator of the specified node.

Safety

The caller must ensure that id is a valid node ID.

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

Returns a reference to the root node.

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

Returns a mutator of the root node.

pub fn orphan(&mut self, value: T) -> NodeMut<'_, T>

Creates an orphan node.

pub fn extend_tree(&mut self, other_tree: Tree<T>) -> NodeMut<'_, T>

Merge with another tree as orphan, returning the new root of tree being merged.

pub fn map<F, U>(self, transform: F) -> Tree<U>

where F: FnMut(T) -> U,

Maps a Tree<T> to Tree<U> by applying a function to all node values, copying over the tree’s structure and node ids untouched, consuming self.

pub fn map_ref<F, U>(&self, transform: F) -> Tree<U>

where F: FnMut(&T) -> U,

Maps a &Tree<T> to Tree<U> by applying a function to all node values, copying over the tree’s structure and node ids untouched.

impl<T> Tree<T>

pub fn values(&self) -> Values<'_, T>

Returns an iterator over values in insert order.

pub fn values_mut(&mut self) -> ValuesMut<'_, T>

Returns a mutable iterator over values in insert order.

pub fn nodes(&self) -> Nodes<'_, T>

Returns an iterator over nodes in insert order.

Trait Implementations

impl<T> Clone for Tree<T>

where T: Clone,

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 for Tree<T>

where T: Debug,

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

Formats the value using the given formatter.

impl<T> Display for Tree<T>

where T: Display,

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

Formats the value using the given formatter.

impl<T> Hash for Tree<T>

where T: Hash,

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T> IntoIterator for Tree<T>

type Item = T

The type of the elements being iterated over.

type IntoIter = IntoIter<T>

Which kind of iterator are we turning this into?

fn into_iter(self) -> <Tree<T> as IntoIterator>::IntoIter

Creates an iterator from a value.

impl<T> PartialEq for Tree<T>

where T: PartialEq,

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

where T: Eq,

impl<T> StructuralPartialEq for Tree<T>