Struct ChildrenNodesOwned

pub struct ChildrenNodesOwned<H>(/* private fields */);

Owned children of a node.

The maximum size of the children is nibble_ops::NIBBLE_LENGTH, in order to save memory we represent only the children until the last missing one. For example, if the children are [Some(_), None, Some(_), None, None, None, None, None None, None, None, None, None, None, None, None] we will only store in the vector [Some(_), None, Some(_)].

This is useful to save space in the TrieCache when the children are not fully populated.

Before this struct was introduced, the children were stored in a fixed size array of length nibble_ops::NIBBLE_LENGTH, to make sure there aren’t any direct accesses to the array that we’ve missed, wrap it in its own struct, rather than directly use the Vec.

Implementations

impl<H> ChildrenNodesOwned<H>

pub fn get(&self, index: usize) -> Option<&NodeHandleOwned<H>>

Returns the child at the given index.

pub fn iter(&self) -> impl Iterator<Item = &Option<NodeHandleOwned<H>>>

Returns an iterator over all children.

The size of the iterator is always constant goes up to nibble_ops::NIBBLE_LENGTH, with None representing the missing children.

pub fn allocated_len(&self) -> usize

Returns the number of allocated children.

Trait Implementations

impl<H: Clone> Clone for ChildrenNodesOwned<H>

fn clone(&self) -> ChildrenNodesOwned<H>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<H: Debug> Debug for ChildrenNodesOwned<H>

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

Formats the value using the given formatter.

impl<H: PartialEq> PartialEq for ChildrenNodesOwned<H>

fn eq(&self, other: &ChildrenNodesOwned<H>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<H: Eq> Eq for ChildrenNodesOwned<H>

impl<H> StructuralPartialEq for ChildrenNodesOwned<H>