Struct Node 

pub struct Node<T, C = DefaultStorage>
where
    C: Storage + ?Sized,
{
    pub prefixes: Array256<Vec<T>>,
    pub children: Array256<Vec<Child<C::Container<Self>, T>>>,
}

A trie node logically covering a single (octet) address stride.

Contains prefixes (directly owned by this node) and children (descendants in the trie).

This is the canonical stride-level Node type for the crate, mirroring go-bart’s Full nodes. The operations its supports are abstracted for via the StrideOps trait – other implementations are possible, e.g. to support similar functionality to go-bart’s Lite and Fast node types.

Fields

prefixes: Array256<Vec<T>>

The prefixes this node covers directly, indexed by BaseIndex.

If this node is at trie depth 3 via octet path [192, 168] for instance, the prefix entry 12/5 => 34 would represent the overall trie route mapping 192.168.12.0/21 => 34.

children: Array256<Vec<Child<C::Container<Self>, T>>>

The children contained in this node, indexed by complete prefix octet.

Implementations

impl<T, C> Node<T, C>

where C: Storage + ?Sized,

pub fn descendants( &self, include_self: bool, ) -> impl Iterator<Item = (Vec<u8, 16>, Child<&Self, &T>)>

Get all the descendant Children of this node. Order is depth-first, in-order by address.

pub fn descendant_nodes( &self, include_self: bool, ) -> impl Iterator<Item = (Vec<u8, 16>, &Self)>

Get all the descendant Nodes of this node. Order is depth-first, in-order by address.

impl<T, C> Node<T, C>

where C: Storage + ?Sized,

pub const EMPTY: Self

The empty node value (no children, no prefixes).

pub const fn is_empty(&self) -> bool

Returns whether the node is empty.

pub fn stats(&self) -> Stats

where Self: StrideOps,

Return usage statistics for the trie rooted at this node.

Trait Implementations

impl<T, C> Clone for Node<T, C>

where C: Storage + ?Sized, T: Clone,

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T, C> Debug for Node<T, C>

where T: Debug, C: Storage + ?Sized,

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

Formats the value using the given formatter.

impl<T, C> Default for Node<T, C>

where C: Storage + ?Sized,

fn default() -> Self

Returns the “default value” for a type.

impl<T: Eq, C> Eq for Node<T, C>

where C: Storage + ?Sized + Eq, C::Container<Self>: Eq,

impl<T: Hash, C> Hash for Node<T, C>

where C: Storage + ?Sized + Hash, C::Container<Self>: Hash,

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T: PartialEq, C> PartialEq for Node<T, C>

where C: Storage + ?Sized + PartialEq, C::Container<Self>: PartialEq,

fn eq(&self, other: &Node<T, C>) -> 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<T, C> PrefixOps for Node<T, C>

where T: 'static, C: Storage + ?Sized,

fn insert_prefix(&mut self, idx: BaseIndex, value: Self::T) -> Option<Self::T>

Insert a value at the given base index.

fn remove_prefix(&mut self, idx: BaseIndex) -> Option<Self::T>

Remove the value for the given base index.

fn get_prefix_exact_mut(&mut self, idx: BaseIndex) -> Option<&mut Self::T>

Get a mutable reference to the prefix value that matches the given index exactly.

impl<T, C> PrefixReadOps for Node<T, C>

where T: 'static, C: Storage + ?Sized,

fn prefix_bitset(&self) -> &Bitset256

Get a reference to the prefix bitset.

fn prefix_count(&self) -> usize

Get the number of prefixes in this node.

fn lookup_index(&self, idx: BaseIndex) -> Option<(BaseIndex, &Self::T)>

Lookup the prefix value that covers the given index.

fn get_prefix_exact(&self, idx: BaseIndex) -> Option<&Self::T>

Get a reference to the prefix value that matches the given index exactly.

impl<T, C> StrideBase for Node<T, C>

where T: 'static, C: Storage + ?Sized,

type T = T

The kind of value held inside nodes.

impl<T, C> StrideOps for Node<T, C>

where T: 'static, C: Storage + ?Sized,

fn child_bitset(&self) -> &Bitset256

Get a reference to the child bitset.

fn child_count(&self) -> usize

Get the number of direct children of this node.

fn stats(&self) -> Stats

Calculate trie occupancy stats for this node and its descendants.

fn insert_child( &mut self, addr: u8, child: Child<Self, Self::T>, ) -> Option<Child<Self, Self::T>>

Insert a child node at the given address.

fn direct_children(&self) -> impl Iterator<Item = (u8, Child<&Self, &T>)>

Iterate the direct children of this node.

fn remove_child(&mut self, addr: u8) -> Option<Child<Self, Self::T>>

Remove a child node at the given address.

fn get_child(&self, addr: u8) -> Option<Child<&Self, &Self::T>>

Get a child node by address.

fn get_child_mut(&mut self, addr: u8) -> Option<Child<&mut Self, &mut Self::T>>

Get a mutable reference to a child node by address.

fn direct_prefixes(&self) -> impl Iterator<Item = (BaseIndex, &T)>

Iterate the prefixes directly contained in this node.

impl<T, C> StructuralPartialEq for Node<T, C>

where C: Storage + ?Sized,