Struct reth_trie::BranchNodeRef

pub struct BranchNodeRef<'a> {
    pub stack: &'a [Vec<u8>],
    pub state_mask: &'a TrieMask,
}

A reference to BranchNode and its state mask. NOTE: The stack may contain more items that specified in the state mask.

Fields

stack: &'a [Vec<u8>]

Reference to the collection of RLP encoded nodes. NOTE: The referenced stack might have more items than the number of children for this node. We should only ever access items starting from BranchNodeRef::first_child_index.

state_mask: &'a TrieMask

Reference to bitmask indicating the presence of children at the respective nibble positions.

Implementations

impl<'a> BranchNodeRef<'a>

pub const fn new( stack: &'a [Vec<u8>], state_mask: &'a TrieMask, ) -> BranchNodeRef<'a>

Create a new branch node from the stack of nodes.

pub fn first_child_index(&self) -> usize

Returns the stack index of the first child for this node.

Panics

If the stack length is less than number of children specified in state mask. Means that the node is in inconsistent state.

pub fn child_hashes( &self, hash_mask: TrieMask, ) -> impl Iterator<Item = FixedBytes<32>>

Given the hash mask of children, return an iterator over stack items that match the mask.

pub fn indexed_children(&self) -> impl Iterator<Item = (u8, FixedBytes<32>)>

Return an iterator over stack items and corresponding indices that match the state mask.

pub fn prefixed_children( &self, prefix: Nibbles, ) -> impl Iterator<Item = (Nibbles, FixedBytes<32>)>

Given the prefix, return an iterator over stack items that match the state mask and their corresponding full paths.

pub fn rlp(&self, out: &mut Vec<u8>) -> Vec<u8>

Returns the RLP encoding of the branch node given the state mask of children present.

Trait Implementations

impl<'a> Clone for BranchNodeRef<'a>

fn clone(&self) -> BranchNodeRef<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BranchNodeRef<'_>

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

Formats the value using the given formatter.

impl Encodable for BranchNodeRef<'_>

Implementation of RLP encoding for branch node in Ethereum Merkle Patricia Trie. Encode it as a 17-element list consisting of 16 slots that correspond to each child of the node (0-f) and an additional slot for a value.

fn encode(&self, out: &mut dyn BufMut)

Encodes the type into the out buffer.

fn length(&self) -> usize

Returns the length of the encoding of this type in bytes.

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 24 bytes