Struct Tree 

pub struct Tree<C: Cookie, I: NodeIndex, O: OptionalNodeIndex<I>, K: NodeKey<C, I>, N> { /* private fields */ }

A vector-backed tree where you can store nodes

Implementations

impl<C: Cookie, I: NodeIndex, O: OptionalNodeIndex<I>, K: NodeKey<C, I>, N> Tree<C, I, O, K, N>

pub fn new() -> Self

pub fn node_key(&self, index: I) -> K

pub fn get(&self, key: K) -> Option<&N>

pub fn get_mut(&mut self, key: K) -> Option<&mut N>

impl<C: Cookie, I: NodeIndex, O: OptionalNodeIndex<I>, K: NodeKey<C, I>, N: Default> Tree<C, I, O, K, N>

pub fn create(&mut self) -> K

Allocate a node in the internal vector

pub fn delete_children(&mut self, key: K)

Remove the children of a node from the tree

Internal references to the nodes are removed (links with siblings & parent). This function behaves recursively to remove nodes from leaf to branch.

pub fn delete(&mut self, key: K)

Remove a node and its children from the tree

Internal references to the node are removed (links with siblings & parent). This function behaves recursively to remove nodes from leaf to branch.

pub fn reset(&mut self, key: K)

Removes the children of a node and reset its public properties to their defaults

pub fn insert_after(&mut self, prev: K, key: K)

Insert a node as the next sibling of prev

pub fn append_children(&mut self, key: K, parent: K)

Adds one or multiple “children” nodes to a “parent” node

node and all it’s siblings are appended to the list of children of parent.

pub fn replace(&mut self, old: K, new: K)

Change references to old so that they point to new instead and remove old

pub fn detach_children(&mut self, parent: K) -> Option<K>

Detach a node from all its “children”, leaving them “orphans”

If the node had no children, None is returned.

pub fn child_index(&self, key: K) -> Option<usize>

Get the index of this node relative to its parent’s children

pub fn parent(&self, key: K) -> Option<K>

Locate the parent of a node

pub fn first_child(&self, key: K) -> Option<K>

Locate the first child of a node

pub fn last_child(&self, key: K) -> Option<K>

Locate the last child of a node

pub fn prev_sibling(&self, key: K) -> K

Locate the previous sibling of a node

Note: siblings are looping, meaning that calling this for the first child of a node will locate the last child of the node.

pub fn next_sibling(&self, key: K) -> K

Locate the next sibling of a node

Note: siblings are looping, meaning that calling this for the last child of a node will locate the first child of the node.

pub fn is_only_child(&self, key: K) -> bool

Returns true if node has no sibling except itself

Trait Implementations

impl<C: Cookie, I: NodeIndex, O: OptionalNodeIndex<I>, K: NodeKey<C, I>, N: Default + Debug> Debug for Tree<C, I, O, K, N>

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

Formats the value using the given formatter.

impl<C: Cookie, I: NodeIndex, O: OptionalNodeIndex<I>, K: NodeKey<C, I>, N> Index<K> for Tree<C, I, O, K, N>

type Output = N

The returned type after indexing.

fn index(&self, key: K) -> &N

Performs the indexing (container[index]) operation.

impl<C: Cookie, I: NodeIndex, O: OptionalNodeIndex<I>, K: NodeKey<C, I>, N> IndexMut<K> for Tree<C, I, O, K, N>

fn index_mut(&mut self, key: K) -> &mut N

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