Struct FlatTree

pub struct FlatTree<K, V> {
    pub nodes: BTreeMap<K, V>,
    pub roots: BTreeSet<K>,
}

A common abstraction of a ‘flat’ tree which tracks the nodes with an ordered map and the set of root nodes.

Note that the data structures use ordered maps and sets which work well with the incrementing crate::Id key.

Fields

nodes: BTreeMap<K, V>

The nodes.

roots: BTreeSet<K>

The set of root nodes.

Implementations

impl<K, V> FlatTree<K, V>

where K: Clone + Eq + Ord,

pub fn get<Q>(&self, k: &Q) -> Option<&V>

where K: Borrow<Q>, Q: Eq + Ord,

Get a node’s value using the key.

pub fn get_mut<Q>(&mut self, k: &Q) -> Option<&mut V>

where K: Borrow<Q>, Q: Eq + Ord,

Get a node’s value (mutable reference) using the key.

pub fn insert_root(&mut self, k: K, v: V) -> Option<V>

Insert a root node.

pub fn insert(&mut self, k: K, v: V) -> Option<V>

Insert a node.

If the node is a root node, insert_root should be used.

pub fn remove<Q>(&mut self, k: &Q) -> Option<V>

where K: Borrow<Q>, Q: Eq + Ord,

Remove a node with the key.

pub fn contains_node<Q>(&self, k: &Q) -> bool

where K: Borrow<Q>, Q: Eq + Ord,

Does the structure contain a node with the key.

pub fn is_root<Q>(&self, k: &Q) -> bool

where K: Borrow<Q>, Q: Eq + Ord,

Check if a key is a root node.

pub fn roots(&self) -> impl Iterator<Item = (&K, &V)>

An iterator over the roots, fetching the nodes’ values.

Trait Implementations

impl<K, V> Default for FlatTree<K, V>

fn default() -> Self

Returns the “default value” for a type.