Struct microkelvin::BranchMut

pub struct BranchMut<'a, C, A>(_);

Reprents a branch view into a collection.

BranchMut allows you to manipulate the value of the leaf, but disallows manipulating the branch nodes directly, to avoid breaking any datastructure invariants.

Branches are always guaranteed to point at a leaf, and can be dereferenced to the pointed-at leaf.

Implementations

impl<'a, C, A> BranchMut<'a, C, A> where
    C: Compound<A>,
    A: Canon, 

pub fn depth(&self) -> usize

Returns the depth of the branch

pub fn map_leaf<M>(
    self,
    closure: for<'b> fn(_: &'b mut C::Leaf) -> &'b mut M
) -> MappedBranchMut<'a, C, A, M>

Returns a branch that maps the leaf to a specific value. Used in maps for example, to get easy access to the value of the KV-pair

pub fn walk<W>(root: &'a mut C, walker: W) -> Result<Option<Self>, CanonError> where
    W: Walker<C, A>,
    C: Canon, 

Performs a tree walk, returning either a valid branch or None if the walk failed.

Trait Implementations

impl<'a, C, A> Deref for BranchMut<'a, C, A> where
    C: Compound<A>,
    A: Canon, 

type Target = C::Leaf

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'a, C, A> DerefMut for BranchMut<'a, C, A> where
    C: Compound<A> + Clone,
    A: Canon, 

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<'a, C, A> IntoIterator for BranchMut<'a, C, A> where
    C: Compound<A>,
    A: Canon, 

type Item = Result<&'a mut C::Leaf, CanonError>

The type of the elements being iterated over.

type IntoIter = BranchMutIterator<'a, C, A, AllLeaves>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.