Struct sp_trie::recorder::Recorder

pub struct Recorder<H: Hasher> { /* private fields */ }

The trie recorder.

Owns the recorded data. Is used to transform data into a storage proof and to provide transaction support. The as_trie_recorder method provides a trie_db::TrieDB compatible recorder that implements the actual recording logic.

Implementations

impl<H: Hasher> Recorder<H>

pub fn recorded_keys( &self ) -> HashMap<<H as Hasher>::Out, HashMap<Arc<[u8]>, RecordedForKey>>

Returns RecordedForKey per recorded key per trie.

There are multiple tries when working with e.g. child tries.

pub fn as_trie_recorder(&self, storage_root: H::Out) -> TrieRecorder<'_, H>

Returns the recorder as TrieRecorder compatible type.

• storage_root: The storage root of the trie for which accesses are recorded. This is important when recording access to different tries at once (like top and child tries).

NOTE: This locks a mutex that stays locked until the return value is dropped.

pub fn drain_storage_proof(self) -> StorageProof

Drain the recording into a StorageProof.

While a recorder can be cloned, all share the same internal state. After calling this function, all other instances will have their internal state reset as well.

If you don’t want to drain the recorded state, use Self::to_storage_proof.

Returns the StorageProof.

pub fn to_storage_proof(&self) -> StorageProof

Convert the recording to a StorageProof.

In contrast to Self::drain_storage_proof this doesn’t consumes and doesn’t clears the recordings.

Returns the StorageProof.

pub fn estimate_encoded_size(&self) -> usize

Returns the estimated encoded size of the proof.

The estimation is based on all the nodes that were accessed until now while accessing the trie.

pub fn reset(&self)

Reset the state.

This discards all recorded data.

pub fn start_transaction(&self)

Start a new transaction.

pub fn rollback_transaction(&self) -> Result<(), ()>

Rollback the latest transaction.

Returns an error if there wasn’t any active transaction.

pub fn commit_transaction(&self) -> Result<(), ()>

Commit the latest transaction.

Returns an error if there wasn’t any active transaction.

Trait Implementations

impl<H: Hasher> Clone for Recorder<H>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<H: Hasher> Default for Recorder<H>

fn default() -> Self

Returns the “default value” for a type.

impl<H: Hasher> ProofSizeProvider for Recorder<H>

fn estimate_encoded_size(&self) -> usize

Returns the storage proof size.

impl<H: Hasher> TrieRecorderProvider<H> for Recorder<H>

type Recorder<'a> = TrieRecorder<'a, H> where H: 'a

Recorder type that is going to be returned by implementors of this trait.

fn drain_storage_proof(self) -> Option<StorageProof>

Create a StorageProof derived from the internal state.

fn as_trie_recorder(&self, storage_root: H::Out) -> Self::Recorder<'_>

Provide a recorder implementing trie_db::TrieRecorder.