Struct microkelvin::Branch

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

Reprents an immutable branch view into a collection.

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

Implementations

impl<'a, C, A> Branch<'a, C, A> where
    C: Compound<A>,
    A: Combine<C, A>, 

pub fn depth(&self) -> usize

Returns the depth of the branch

pub fn levels(&self) -> &[Level<'_, C, A>]

Returns a slice into the levels of the tree.

pub fn map_leaf<M>(
    self,
    closure: for<'b> fn(_: &'b C::Leaf) -> &'b M
) -> MappedBranch<'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 C, walker: W) -> Result<Option<Self>, CanonError> where
    W: Walker<C, A>, 

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

pub fn path<P>(root: &'a C, path: P) -> Result<Option<Self>, CanonError> where
    P: FnMut() -> usize, 

Construct a branch given a function returning child offsets

Trait Implementations

impl<'a, C: Debug, A: Debug> Debug for Branch<'a, C, A>

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

Formats the value using the given formatter.

impl<'a, C, A> Deref for Branch<'a, C, A> where
    C: Compound<A>,
    A: Combine<C, A>, 

type Target = C::Leaf

The resulting type after dereferencing.

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

Dereferences the value.

impl<'a, C, A> IntoIterator for Branch<'a, C, A> where
    C: Compound<A>,
    A: Combine<C, A>, 

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

The type of the elements being iterated over.

type IntoIter = BranchIterator<'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.