Struct Tree 

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

A tree where all values (T) are stored in a single contiguous list, and the inner tree (Nodes) is made up of branches with indices into the flat list.

This means fewer allocations when removing entire branches as we can reuse the memory for the values.

Implementations

impl<T> Tree<T>

pub const fn empty() -> Self

Create an empty tree

pub fn view(&mut self) -> TreeView<'_, T>

pub fn get_ref(&mut self, value_id: ValueId) -> Option<&T>

Get a refernence to a value

pub fn get_mut(&mut self, value_id: ValueId) -> Option<&mut T>

Get a mutable refernence to a value

pub fn values(self) -> TreeValues<T>

Consume the tree and return the values

pub fn drain_removed(&mut self) -> impl DoubleEndedIterator<Item = ValueId> + '_

Drain the removed value ids. This will not return keys that have been replaced.

pub fn with_value_mut<F, V>(&mut self, value_id: ValueId, f: F) -> V

where F: FnOnce(&[u16], &mut T, &mut Self) -> V,

Perform a given operation (F) on a mutable reference to a value in the tree while still having mutable access to the rest of the tree.

Panics

This will panic if the value is already checked out

Trait Implementations

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

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

Formats the value using the given formatter.