Struct cl_structures::tree::Tree

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

An insert-only unordered tree, backed by a Vec

Implementations

impl<T> Tree<T>

Getters

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

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

pub fn get_node(&self, index: Ref<T>) -> Option<&Node<T>>

pub fn get_node_mut(&mut self, index: Ref<T>) -> Option<&mut Node<T>>

impl<T> Tree<T>

Tree operations

pub fn new() -> Self

pub fn root(&mut self, value: T) -> Result<Ref<T>, T>

Creates a new root for the tree.

If the tree already has a root, the value will be returned.

pub fn get_root(&mut self) -> Option<Ref<T>>

pub fn insert(&mut self, value: T, parent: Ref<T>) -> Ref<T>

Insert a value into the tree as a child of the parent node

Panics

May panic if the node Ref is from a different tree

pub fn depth(&self, node: Ref<T>) -> usize

Gets the depth of a node

Panics

May panic if the node Ref is from a different tree

pub fn branches(&self) -> usize

Gets the number of branches in the tree

impl<T> Tree<T>

Standard data structure functions

pub fn len(&self) -> usize

pub fn is_empty(&self) -> bool

Trait Implementations

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

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

Formats the value using the given formatter.

impl<T> Default for Tree<T>

fn default() -> Self

Returns the “default value” for a type.

impl<T> Index<Ref<T>> for Tree<T>

type Output = Node<T>

The returned type after indexing.

fn index(&self, index: Ref<T>) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<T> IndexMut<Ref<T>> for Tree<T>

fn index_mut(&mut self, index: Ref<T>) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.