Enum trie_db::node::NodePlan

pub enum NodePlan {
    Empty,
    Leaf {
        partial: NibbleSlicePlan,
        value: ValuePlan,
    },
    Extension {
        partial: NibbleSlicePlan,
        child: NodeHandlePlan,
    },
    Branch {
        value: Option<ValuePlan>,
        children: [Option<NodeHandlePlan>; 16],
    },
    NibbledBranch {
        partial: NibbleSlicePlan,
        value: Option<ValuePlan>,
        children: [Option<NodeHandlePlan>; 16],
    },
}

A NodePlan is a blueprint for decoding a node from a byte slice. The NodePlan is created by parsing an encoded node and can be reused multiple times. This is useful as a Node borrows from a byte slice and this struct does not.

The enum values mirror those of Node except that instead of byte slices, this struct stores ranges that can be used to index into a large byte slice.

Variants

Empty

Null trie node; could be an empty root or an empty branch entry.

Leaf

Leaf node; has a partial key plan and value.

Fields

partial: NibbleSlicePlan

value: ValuePlan

Extension

Extension node; has a partial key plan and child data.

Fields

partial: NibbleSlicePlan

child: NodeHandlePlan

Branch

Branch node; has slice of child nodes (each possibly null) and an optional immediate node data.

Fields

value: Option<ValuePlan>

children: [Option<NodeHandlePlan>; 16]

NibbledBranch

Branch node with support for a nibble (when extension nodes are not used).

Fields

partial: NibbleSlicePlan

value: Option<ValuePlan>

children: [Option<NodeHandlePlan>; 16]

Implementations

impl NodePlan

pub fn build<'a, 'b>(&'a self, data: &'b [u8]) -> Node<'b>

Build a node by decoding a byte slice according to the node plan. It is the responsibility of the caller to ensure that the node plan was created for the argument data, otherwise the call may decode incorrectly or panic.

pub fn value_plan(&self) -> Option<&ValuePlan>

Access value plan from node plan, return None for node that cannot contain a ValuePlan.

pub fn value_plan_mut(&mut self) -> Option<&mut ValuePlan>

Mutable ccess value plan from node plan, return None for node that cannot contain a ValuePlan.

Trait Implementations

impl Clone for NodePlan

fn clone(&self) -> NodePlan

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for NodePlan

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

Formats the value using the given formatter.

impl PartialEq for NodePlan

fn eq(&self, other: &NodePlan) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

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

impl Eq for NodePlan

impl StructuralPartialEq for NodePlan