Struct BranchNodeCompact

pub struct BranchNodeCompact {
    pub state_mask: TrieMask,
    pub tree_mask: TrieMask,
    pub hash_mask: TrieMask,
    pub hashes: Vec<FixedBytes<32>>,
    pub root_hash: Option<FixedBytes<32>>,
}

A struct representing a branch node in an Ethereum trie.

A branch node can have up to 16 children, each corresponding to one of the possible nibble values (0 to f) in the trie’s path.

The masks in a BranchNode are used to efficiently represent and manage information about the presence and types of its children. They are bitmasks, where each bit corresponds to a nibble (half-byte, or 4 bits) value from 0 to f.

Fields

state_mask: TrieMask

The bitmask indicating the presence of children at the respective nibble positions in the trie. If the bit at position i (counting from the right) is set (1), it indicates that a child exists for the nibble value i. If the bit is unset (0), it means there is no child for that nibble value.

tree_mask: TrieMask

The bitmask representing the children at the respective nibble positions in the trie that are also stored in the database. If the bit at position i (counting from the right) is set (1) and also present in the state_mask, it indicates that the corresponding child at the nibble value i is stored in the database. If the bit is unset (0), it means the child is not stored in the database.

hash_mask: TrieMask

The bitmask representing the hashed branch children nodes at the respective nibble positions in the trie. If the bit at position i (counting from the right) is set (1) and also present in the state_mask, it indicates that the corresponding child at the nibble value i is a hashed branch child node. If the bit is unset (0), it means the child is not a hashed branch child node.

hashes: Vec<FixedBytes<32>>

Collection of hashes associated with the children of the branch node. Each child hash is calculated by hashing two consecutive sub-branch roots.

root_hash: Option<FixedBytes<32>>

An optional root hash of the subtree rooted at this branch node.

Implementations

impl BranchNodeCompact

pub fn new( state_mask: impl Into<TrieMask>, tree_mask: impl Into<TrieMask>, hash_mask: impl Into<TrieMask>, hashes: Vec<FixedBytes<32>>, root_hash: Option<FixedBytes<32>>, ) -> BranchNodeCompact

Creates a new BranchNodeCompact from the given parameters.

pub fn hash_for_nibble(&self, nibble: u8) -> FixedBytes<32>

Returns the hash associated with the given nibble.

Trait Implementations

impl Clone for BranchNodeCompact

fn clone(&self) -> BranchNodeCompact

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Compact for BranchNodeCompact

fn to_compact<B>(&self, buf: &mut B) -> usize

where B: BufMut + AsMut<[u8]>,

Takes a buffer which can be written to. Ideally, it returns the length written to.

fn from_compact(buf: &[u8], _len: usize) -> (BranchNodeCompact, &[u8])

Takes a buffer which can be read from. Returns the object and buf with its internal cursor advanced (eg..advance(len)).

fn specialized_to_compact<B>(&self, buf: &mut B) -> usize

where B: BufMut + AsMut<[u8]>,

“Optional”: If there’s no good reason to use it, don’t.

fn specialized_from_compact(buf: &[u8], len: usize) -> (Self, &[u8])

“Optional”: If there’s no good reason to use it, don’t.

impl Debug for BranchNodeCompact

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

Formats the value using the given formatter.

impl Default for BranchNodeCompact

fn default() -> BranchNodeCompact

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for BranchNodeCompact

fn deserialize<__D>( __deserializer: __D, ) -> Result<BranchNodeCompact, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Ord for BranchNodeCompact

fn cmp(&self, other: &BranchNodeCompact) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for BranchNodeCompact

fn eq(&self, other: &BranchNodeCompact) -> 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 PartialOrd for BranchNodeCompact

fn partial_cmp(&self, other: &BranchNodeCompact) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for BranchNodeCompact

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for BranchNodeCompact

impl StructuralPartialEq for BranchNodeCompact

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: 64 bytes