Struct sp_state_machine::TrieBackend

pub struct TrieBackend<S: TrieBackendStorage<H>, H: Hasher, C = LocalTrieCache<H>> { /* private fields */ }

Patricia trie-based backend. Transaction type is an overlay of changes to commit.

Implementations

impl<H: Hasher, KF> TrieBackend<GenericMemoryDB<H, KF>, H>where
    H::Out: Codec + Ord,
    KF: KeyFunction<H> + Send + Sync,

pub fn update<T: IntoIterator<Item = (Option<ChildInfo>, StorageCollection)>>(
    &self,
    changes: T,
    state_version: StateVersion
) -> Self

Copy the state, with applied updates

pub fn insert<T: IntoIterator<Item = (Option<ChildInfo>, StorageCollection)>>(
    &mut self,
    changes: T,
    state_version: StateVersion
)

Insert values into backend trie.

pub fn update_backend(
    &self,
    root: H::Out,
    changes: GenericMemoryDB<H, KF>
) -> Self

Merge trie nodes into this backend.

pub fn apply_transaction(
    &mut self,
    root: H::Out,
    transaction: GenericMemoryDB<H, KF>
)

Apply the given transaction to this backend and set the root to the given value.

pub fn eq(&self, other: &Self) -> bool

Compare with another in-memory backend.

impl<S: TrieBackendStorage<H>, H: Hasher, C: AsLocalTrieCache<H> + Send + Sync> TrieBackend<S, H, C>where
    H::Out: Codec,

pub fn essence(&self) -> &TrieBackendEssence<S, H, C>

Get backend essence reference.

pub fn backend_storage(&self) -> &S

Get backend storage reference.

pub fn root(&self) -> &H::Out

Get trie root.

pub fn into_storage(self) -> S

Consumes self and returns underlying storage.

pub fn extract_proof(self) -> Option<StorageProof>

Extract the StorageProof.

This only returns Some when there was a recorder set.

Trait Implementations

impl<S: TrieBackendStorage<H>, H: Hasher, C> AsTrieBackend<H, C> for TrieBackend<S, H, C>

type TrieBackendStorage = S

Type of trie backend storage.

fn as_trie_backend(&self) -> &TrieBackend<S, H, C>

Return the type as TrieBackend.

impl<S: TrieBackendStorage<H>, H: Hasher, C: AsLocalTrieCache<H> + Send + Sync> Backend<H> for TrieBackend<S, H, C>where
    H::Out: Ord + Codec,

type Error = String

An error type when fetching data is not possible.

type Transaction = <S as TrieBackendStorage<H>>::Overlay

Storage changes to be applied if committing

type TrieBackendStorage = S

Type of trie backend storage.

fn storage_hash(&self, key: &[u8]) -> Result<Option<H::Out>, Self::Error>

Get keyed storage value hash or None if there is nothing associated.

fn storage(&self, key: &[u8]) -> Result<Option<StorageValue>, Self::Error>

Get keyed storage or None if there is nothing associated.

fn child_storage_hash(
    &self,
    child_info: &ChildInfo,
    key: &[u8]
) -> Result<Option<H::Out>, Self::Error>

Get child keyed storage value hash or None if there is nothing associated.

fn child_storage(
    &self,
    child_info: &ChildInfo,
    key: &[u8]
) -> Result<Option<StorageValue>, Self::Error>

Get keyed child storage or None if there is nothing associated.

fn next_storage_key(&self, key: &[u8]) -> Result<Option<StorageKey>, Self::Error>

Return the next key in storage in lexicographic order or None if there is no value.

fn next_child_storage_key(
    &self,
    child_info: &ChildInfo,
    key: &[u8]
) -> Result<Option<StorageKey>, Self::Error>

Return the next key in child storage in lexicographic order or None if there is no value.

fn for_keys_with_prefix<F: FnMut(&[u8])>(&self, prefix: &[u8], f: F)

Retrieve all entries keys which start with the given prefix and call f for each of those keys.

fn for_key_values_with_prefix<F: FnMut(&[u8], &[u8])>(&self, prefix: &[u8], f: F)

Retrieve all entries keys and values of which start with the given prefix and call f for each of those keys.

fn apply_to_key_values_while<F: FnMut(Vec<u8>, Vec<u8>) -> bool>(
    &self,
    child_info: Option<&ChildInfo>,
    prefix: Option<&[u8]>,
    start_at: Option<&[u8]>,
    f: F,
    allow_missing: bool
) -> Result<bool, Self::Error>

Iterate over storage starting at key, for a given prefix and child trie. Aborts as soon as f returns false. Warning, this fails at first error when usual iteration skips errors. If allow_missing is true, iteration stops when it reaches a missing trie node. Otherwise an error is produced.

fn apply_to_keys_while<F: FnMut(&[u8]) -> bool>(
    &self,
    child_info: Option<&ChildInfo>,
    prefix: Option<&[u8]>,
    start_at: Option<&[u8]>,
    f: F
)

Retrieve all entries keys of storage and call f for each of those keys. Aborts as soon as f returns false.

fn for_child_keys_with_prefix<F: FnMut(&[u8])>(
    &self,
    child_info: &ChildInfo,
    prefix: &[u8],
    f: F
)

Retrieve all child entries keys which start with the given prefix and call f for each of those keys.

fn pairs(&self) -> Vec<(StorageKey, StorageValue)>

Get all key/value pairs into a Vec.

fn keys(&self, prefix: &[u8]) -> Vec<StorageKey>

Get all keys with given prefix

fn storage_root<'a>(
    &self,
    delta: impl Iterator<Item = (&'a [u8], Option<&'a [u8]>)>,
    state_version: StateVersion
) -> (H::Out, Self::Transaction)where
    H::Out: Ord,

Calculate the storage root, with given delta over what is already stored in the backend, and produce a “transaction” that can be used to commit. Does not include child storage updates.

fn child_storage_root<'a>(
    &self,
    child_info: &ChildInfo,
    delta: impl Iterator<Item = (&'a [u8], Option<&'a [u8]>)>,
    state_version: StateVersion
) -> (H::Out, bool, Self::Transaction)where
    H::Out: Ord,

Calculate the child storage root, with given delta over what is already stored in the backend, and produce a “transaction” that can be used to commit. The second argument is true if child storage root equals default storage root.

fn register_overlay_stats(&self, _stats: &StateMachineStats)

Register stats from overlay of state machine.

fn usage_info(&self) -> UsageInfo

Query backend usage statistics (i/o, memory)

fn wipe(&self) -> Result<(), Self::Error>

Wipe the state database.

fn exists_storage(&self, key: &[u8]) -> Result<bool, Self::Error>

true if a key exists in storage.

fn exists_child_storage(
    &self,
    child_info: &ChildInfo,
    key: &[u8]
) -> Result<bool, Self::Error>

true if a key exists in child storage.

fn child_keys(&self, child_info: &ChildInfo, prefix: &[u8]) -> Vec<StorageKey>

Get all keys of child storage with given prefix

fn full_storage_root<'a>(
    &self,
    delta: impl Iterator<Item = (&'a [u8], Option<&'a [u8]>)>,
    child_deltas: impl Iterator<Item = (&'a ChildInfo, impl Iterator<Item = (&'a [u8], Option<&'a [u8]>)>)>,
    state_version: StateVersion
) -> (H::Out, Self::Transaction)where
    H::Out: Ord + Encode,

Calculate the storage root, with given delta over what is already stored in the backend, and produce a “transaction” that can be used to commit. Does include child storage updates.

fn commit(
    &self,
    _: H::Out,
    _: Self::Transaction,
    _: StorageCollection,
    _: ChildStorageCollection
) -> Result<(), Self::Error>

Commit given transaction to storage.

fn read_write_count(&self) -> (u32, u32, u32, u32)

Get the read/write count of the db

fn reset_read_write_count(&self)

Get the read/write count of the db

fn get_whitelist(&self) -> Vec<TrackedStorageKey>

Get the whitelist for tracking db reads/writes

fn set_whitelist(&self, _: Vec<TrackedStorageKey>)

Update the whitelist for tracking db reads/writes

fn proof_size(&self) -> Option<u32>

Estimate proof size

fn get_read_and_written_keys(&self) -> Vec<(Vec<u8>, u32, u32, bool)>

Extend storage info for benchmarking db

impl<H: Hasher, KF> Clone for TrieBackend<GenericMemoryDB<H, KF>, H>where
    H::Out: Codec + Ord,
    KF: KeyFunction<H> + Send + Sync,

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<S: TrieBackendStorage<H>, H: Hasher, C: AsLocalTrieCache<H>> Debug for TrieBackend<S, H, C>

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

Formats the value using the given formatter.

impl<H, KF> Default for TrieBackend<GenericMemoryDB<H, KF>, H>where
    H: Hasher,
    H::Out: Codec + Ord,
    KF: KeyFunction<H> + Send + Sync,

fn default() -> Self

Returns the “default value” for a type.

impl<H: Hasher, KF> From<(BTreeMap<Vec<u8, Global>, Vec<u8, Global>, Global>, StateVersion)> for TrieBackend<GenericMemoryDB<H, KF>, H>where
    H::Out: Codec + Ord,
    KF: KeyFunction<H> + Send + Sync,

fn from(
    (inner, state_version): (BTreeMap<StorageKey, StorageValue>, StateVersion)
) -> Self

Converts to this type from the input type.

impl<H: Hasher, KF> From<(HashMap<Option<ChildInfo>, BTreeMap<Vec<u8, Global>, Vec<u8, Global>, Global>, RandomState>, StateVersion)> for TrieBackend<GenericMemoryDB<H, KF>, H>where
    H::Out: Codec + Ord,
    KF: KeyFunction<H> + Send + Sync,

fn from(
    (inner, state_version): (HashMap<Option<ChildInfo>, BTreeMap<StorageKey, StorageValue>>, StateVersion)
) -> Self

Converts to this type from the input type.

impl<H: Hasher, KF> From<(Storage, StateVersion)> for TrieBackend<GenericMemoryDB<H, KF>, H>where
    H::Out: Codec + Ord,
    KF: KeyFunction<H> + Send + Sync,

fn from((inners, state_version): (Storage, StateVersion)) -> Self

Converts to this type from the input type.

impl<H: Hasher, KF> From<(Vec<(Option<ChildInfo>, Vec<(Vec<u8, Global>, Option<Vec<u8, Global>>), Global>), Global>, StateVersion)> for TrieBackend<GenericMemoryDB<H, KF>, H>where
    H::Out: Codec + Ord,
    KF: KeyFunction<H> + Send + Sync,

fn from(
    (inner, state_version): (Vec<(Option<ChildInfo>, StorageCollection)>, StateVersion)
) -> Self

Converts to this type from the input type.