Struct TrieWalker 

pub struct TrieWalker<C, K = AddedRemovedKeys> {
    pub cursor: C,
    pub stack: Vec<CursorSubNode>,
    pub can_skip_current_node: bool,
    pub changes: PrefixSet,
    /* private fields */
}

Traverses the trie in lexicographic order.

This iterator depends on the ordering guarantees of TrieCursor.

Fields

cursor: C

A mutable reference to a trie cursor instance used for navigating the trie.

stack: Vec<CursorSubNode>

A vector containing the trie nodes that have been visited.

can_skip_current_node: bool

A flag indicating whether the current node can be skipped when traversing the trie. This is determined by whether the current key’s prefix is included in the prefix set and if the hash flag is set.

changes: PrefixSet

A PrefixSet representing the changes to be applied to the trie.

Implementations

impl<C: TrieCursor, K: AsRef<AddedRemovedKeys>> TrieWalker<C, K>

pub fn state_trie_from_stack( cursor: C, stack: Vec<CursorSubNode>, changes: PrefixSet, ) -> Self

Constructs a new TrieWalker for the state trie from existing stack and a cursor.

pub fn storage_trie_from_stack( cursor: C, stack: Vec<CursorSubNode>, changes: PrefixSet, ) -> Self

Constructs a new TrieWalker for the storage trie from existing stack and a cursor.

pub fn with_deletions_retained(self, retained: bool) -> Self

Sets the flag whether the trie updates should be stored.

pub fn with_added_removed_keys<K2>( self, added_removed_keys: Option<K2>, ) -> TrieWalker<C, K2>

Configures the walker to not skip certain branch nodes, even when they are not in the PrefixSet, when they might be needed to support leaf removal.

pub const fn with_walk_all_changed_branch_children(self, enabled: bool) -> Self

Configures the walker to treat every child of a matching branch path as unskippable.

When deletions are retained, also collects stored descendants hidden by a matching branch’s tree mask. These keys appear in the deletion set even if traversal never visits them. Root calculations can replace these deletions with regenerated branch updates.

pub fn split(self) -> (Vec<CursorSubNode>, HashSet<Nibbles>)

Split the walker into stack and trie updates.

pub fn take_removed_keys(&mut self) -> HashSet<Nibbles>

Take removed keys from the walker.

pub fn print_stack(&self)

Prints the current stack of trie nodes.

pub fn removed_keys_len(&self) -> usize

The current length of the removed keys.

pub fn key(&self) -> Option<&Nibbles>

Returns the current key in the trie.

pub fn hash(&self) -> Option<B256>

Returns the current hash in the trie, if any.

pub fn maybe_hash(&self) -> Option<B256>

Returns the current hash in the trie, if any.

Differs from Self::hash in that it returns None if the subnode is positioned at the child without a hash mask bit set. Self::hash panics in that case.

pub fn children_are_in_trie(&self) -> bool

Indicates whether the children of the current node are present in the trie.

pub fn next_unprocessed_key(&self) -> Option<(B256, Nibbles)>

Returns the next unprocessed key in the trie along with its raw Nibbles representation.

pub fn state_trie(cursor: C, changes: PrefixSet) -> Result<Self, DatabaseError>

Constructs a new TrieWalker for the state trie.

pub fn storage_trie( cursor: C, changes: PrefixSet, ) -> Result<Self, DatabaseError>

Constructs a new TrieWalker for the storage trie.

pub fn advance(&mut self) -> Result<(), DatabaseError>

Advances the walker to the next trie node and updates the skip node flag. The new key can then be obtained via key().

Returns

• Result<(), Error> - Unit on success or an error.

Trait Implementations

impl<C: Debug, K: Debug> Debug for TrieWalker<C, K>

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

Formats the value using the given formatter.

Layout

Note: Unable to compute type layout, possibly due to this type having generic parameters. Layout can only be computed for concrete, fully-instantiated types.