Struct ProofRetainer

pub struct ProofRetainer<K = AddedRemovedKeys> { /* private fields */ }

Proof retainer is used to store proofs during merkle trie construction. It is intended to be used within the HashBuilder.

When using the retain_leaf_proof, retain_extension_proof, and retain_branch_proof methods, it is required that the calls are ordered such that proofs of parent nodes are retained after their children.

Implementations

impl ProofRetainer

pub fn new(targets: Vec<Nibbles>) -> Self

Create new retainer with target nibbles.

impl<K> ProofRetainer<K>

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

Configures the retainer to retain proofs for certain nodes which would otherwise fall outside the target set, when those nodes might be required to calculate the state root when keys have been added or removed to the trie.

If None is given then retention of extra proofs is disabled.

impl<K: AsRef<AddedRemovedKeys>> ProofRetainer<K>

pub fn matches(&self, prefix: &Nibbles) -> bool

Returns true if the given prefix matches the retainer target.

pub fn into_proof_nodes(self) -> ProofNodes

Returns all collected proofs.

pub fn retain(&mut self, prefix: &Nibbles, proof: &[u8])

👎Deprecated

Retain the proof if the key matches any of the targets.

Usage of this method should be replaced with usage of the following methods, each dependent on the node-type whose proof being retained:

• retain_empty_root_proof
• retain_leaf_proof
• retain_extension_proof
• retain_branch_proof

pub fn retain_empty_root_proof(&mut self)

Retains a proof for an empty root.

pub fn retain_leaf_proof(&mut self, path: &Nibbles, proof: &[u8])

Retains a proof for a leaf node.

pub fn retain_extension_proof( &mut self, path: &Nibbles, short_key: &Nibbles, proof: &[u8], )

Retains a proof for an extension node.

pub fn retain_branch_proof( &mut self, path: &Nibbles, state_mask: TrieMask, proof: &[u8], )

Retains a proof for a branch node.

Trait Implementations

impl<K: Clone> Clone for ProofRetainer<K>

fn clone(&self) -> ProofRetainer<K>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<K: Debug> Debug for ProofRetainer<K>

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

Formats the value using the given formatter.

impl<K: Default> Default for ProofRetainer<K>

fn default() -> ProofRetainer<K>

Returns the “default value” for a type.

impl FromIterator<Nibbles> for ProofRetainer

fn from_iter<T: IntoIterator<Item = Nibbles>>(iter: T) -> Self

Creates a value from an iterator.