Struct sp_state_machine::TrieBackend
source · pub struct TrieBackend<S: TrieBackendStorage<H>, H: Hasher, C = LocalTrieCache<H>> { /* private fields */ }
Expand description
Patricia trie-based backend. Transaction type is an overlay of changes to commit.
Implementations
sourceimpl<H: Hasher, KF> TrieBackend<GenericMemoryDB<H, KF>, H>where
H::Out: Codec + Ord,
KF: KeyFunction<H> + Send + Sync,
impl<H: Hasher, KF> TrieBackend<GenericMemoryDB<H, KF>, H>where
H::Out: Codec + Ord,
KF: KeyFunction<H> + Send + Sync,
sourcepub fn update<T: IntoIterator<Item = (Option<ChildInfo>, StorageCollection)>>(
&self,
changes: T,
state_version: StateVersion
) -> Self
pub fn update<T: IntoIterator<Item = (Option<ChildInfo>, StorageCollection)>>(
&self,
changes: T,
state_version: StateVersion
) -> Self
Copy the state, with applied updates
sourcepub fn insert<T: IntoIterator<Item = (Option<ChildInfo>, StorageCollection)>>(
&mut self,
changes: T,
state_version: StateVersion
)
pub fn insert<T: IntoIterator<Item = (Option<ChildInfo>, StorageCollection)>>(
&mut self,
changes: T,
state_version: StateVersion
)
Insert values into backend trie.
sourcepub fn update_backend(
&self,
root: H::Out,
changes: GenericMemoryDB<H, KF>
) -> Self
pub fn update_backend(
&self,
root: H::Out,
changes: GenericMemoryDB<H, KF>
) -> Self
Merge trie nodes into this backend.
sourcepub fn apply_transaction(
&mut self,
root: H::Out,
transaction: GenericMemoryDB<H, KF>
)
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.
sourceimpl<S: TrieBackendStorage<H>, H: Hasher, C: AsLocalTrieCache<H> + Send + Sync> TrieBackend<S, H, C>where
H::Out: Codec,
impl<S: TrieBackendStorage<H>, H: Hasher, C: AsLocalTrieCache<H> + Send + Sync> TrieBackend<S, H, C>where
H::Out: Codec,
sourcepub fn backend_storage(&self) -> &S
pub fn backend_storage(&self) -> &S
Get backend storage reference.
sourcepub fn into_storage(self) -> S
pub fn into_storage(self) -> S
Consumes self and returns underlying storage.
sourcepub fn extract_proof(self) -> Option<StorageProof>
pub fn extract_proof(self) -> Option<StorageProof>
Extract the StorageProof
.
This only returns Some
when there was a recorder set.
Trait Implementations
sourceimpl<S: TrieBackendStorage<H>, H: Hasher, C> AsTrieBackend<H, C> for TrieBackend<S, H, C>
impl<S: TrieBackendStorage<H>, H: Hasher, C> AsTrieBackend<H, C> for TrieBackend<S, H, C>
type TrieBackendStorage = S
type TrieBackendStorage = S
Type of trie backend storage.
sourcefn as_trie_backend(&self) -> &TrieBackend<S, H, C>
fn as_trie_backend(&self) -> &TrieBackend<S, H, C>
Return the type as
TrieBackend
.sourceimpl<S: TrieBackendStorage<H>, H: Hasher, C: AsLocalTrieCache<H> + Send + Sync> Backend<H> for TrieBackend<S, H, C>where
H::Out: Ord + Codec,
impl<S: TrieBackendStorage<H>, H: Hasher, C: AsLocalTrieCache<H> + Send + Sync> Backend<H> for TrieBackend<S, H, C>where
H::Out: Ord + Codec,
type Transaction = <S as TrieBackendStorage<H>>::Overlay
type Transaction = <S as TrieBackendStorage<H>>::Overlay
Storage changes to be applied if committing
type TrieBackendStorage = S
type TrieBackendStorage = S
Type of trie backend storage.
sourcefn storage_hash(&self, key: &[u8]) -> Result<Option<H::Out>, Self::Error>
fn storage_hash(&self, key: &[u8]) -> Result<Option<H::Out>, Self::Error>
Get keyed storage value hash or None if there is nothing associated.
sourcefn storage(&self, key: &[u8]) -> Result<Option<StorageValue>, Self::Error>
fn storage(&self, key: &[u8]) -> Result<Option<StorageValue>, Self::Error>
Get keyed storage or None if there is nothing associated.
sourcefn child_storage_hash(
&self,
child_info: &ChildInfo,
key: &[u8]
) -> Result<Option<H::Out>, Self::Error>
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.
sourcefn child_storage(
&self,
child_info: &ChildInfo,
key: &[u8]
) -> Result<Option<StorageValue>, Self::Error>
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.
sourcefn next_storage_key(&self, key: &[u8]) -> Result<Option<StorageKey>, Self::Error>
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.sourcefn next_child_storage_key(
&self,
child_info: &ChildInfo,
key: &[u8]
) -> Result<Option<StorageKey>, Self::Error>
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.sourcefn for_keys_with_prefix<F: FnMut(&[u8])>(&self, prefix: &[u8], f: F)
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. Read moresourcefn for_key_values_with_prefix<F: FnMut(&[u8], &[u8])>(&self, prefix: &[u8], f: F)
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. Read moresourcefn 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>
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. Read moresourcefn apply_to_keys_while<F: FnMut(&[u8]) -> bool>(
&self,
child_info: Option<&ChildInfo>,
prefix: Option<&[u8]>,
start_at: Option<&[u8]>,
f: F
)
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. Read moresourcefn for_child_keys_with_prefix<F: FnMut(&[u8])>(
&self,
child_info: &ChildInfo,
prefix: &[u8],
f: F
)
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. Read moresourcefn pairs(&self) -> Vec<(StorageKey, StorageValue)> ⓘ
fn pairs(&self) -> Vec<(StorageKey, StorageValue)> ⓘ
Get all key/value pairs into a Vec.
sourcefn storage_root<'a>(
&self,
delta: impl Iterator<Item = (&'a [u8], Option<&'a [u8]>)>,
state_version: StateVersion
) -> (H::Out, Self::Transaction)where
H::Out: Ord,
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. Read more
sourcefn 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,
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. Read more
sourcefn register_overlay_stats(&self, _stats: &StateMachineStats)
fn register_overlay_stats(&self, _stats: &StateMachineStats)
Register stats from overlay of state machine. Read more
sourcefn usage_info(&self) -> UsageInfo
fn usage_info(&self) -> UsageInfo
Query backend usage statistics (i/o, memory) Read more
sourcefn exists_storage(&self, key: &[u8]) -> Result<bool, Self::Error>
fn exists_storage(&self, key: &[u8]) -> Result<bool, Self::Error>
true if a key exists in storage.
sourcefn exists_child_storage(
&self,
child_info: &ChildInfo,
key: &[u8]
) -> Result<bool, Self::Error>
fn exists_child_storage(
&self,
child_info: &ChildInfo,
key: &[u8]
) -> Result<bool, Self::Error>
true if a key exists in child storage.
sourcefn child_keys(&self, child_info: &ChildInfo, prefix: &[u8]) -> Vec<StorageKey> ⓘ
fn child_keys(&self, child_info: &ChildInfo, prefix: &[u8]) -> Vec<StorageKey> ⓘ
Get all keys of child storage with given prefix
sourcefn 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,
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. Read more
sourcefn commit(
&self,
_: H::Out,
_: Self::Transaction,
_: StorageCollection,
_: ChildStorageCollection
) -> Result<(), Self::Error>
fn commit(
&self,
_: H::Out,
_: Self::Transaction,
_: StorageCollection,
_: ChildStorageCollection
) -> Result<(), Self::Error>
Commit given transaction to storage.
sourcefn reset_read_write_count(&self)
fn reset_read_write_count(&self)
Get the read/write count of the db
sourcefn get_whitelist(&self) -> Vec<TrackedStorageKey> ⓘ
fn get_whitelist(&self) -> Vec<TrackedStorageKey> ⓘ
Get the whitelist for tracking db reads/writes
sourcefn set_whitelist(&self, _: Vec<TrackedStorageKey>)
fn set_whitelist(&self, _: Vec<TrackedStorageKey>)
Update the whitelist for tracking db reads/writes
sourcefn proof_size(&self) -> Option<u32>
fn proof_size(&self) -> Option<u32>
Estimate proof size
sourceimpl<H: Hasher, KF> Clone for TrieBackend<GenericMemoryDB<H, KF>, H>where
H::Out: Codec + Ord,
KF: KeyFunction<H> + Send + Sync,
impl<H: Hasher, KF> Clone for TrieBackend<GenericMemoryDB<H, KF>, H>where
H::Out: Codec + Ord,
KF: KeyFunction<H> + Send + Sync,
sourceimpl<S: TrieBackendStorage<H>, H: Hasher, C: AsLocalTrieCache<H>> Debug for TrieBackend<S, H, C>
impl<S: TrieBackendStorage<H>, H: Hasher, C: AsLocalTrieCache<H>> Debug for TrieBackend<S, H, C>
sourceimpl<H, KF> Default for TrieBackend<GenericMemoryDB<H, KF>, H>where
H: Hasher,
H::Out: Codec + Ord,
KF: KeyFunction<H> + Send + Sync,
impl<H, KF> Default for TrieBackend<GenericMemoryDB<H, KF>, H>where
H: Hasher,
H::Out: Codec + Ord,
KF: KeyFunction<H> + Send + Sync,
sourceimpl<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,
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,
sourcefn from(
(inner, state_version): (BTreeMap<StorageKey, StorageValue>, StateVersion)
) -> Self
fn from(
(inner, state_version): (BTreeMap<StorageKey, StorageValue>, StateVersion)
) -> Self
Converts to this type from the input type.
sourceimpl<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,
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,
sourcefn from(
(inner, state_version): (HashMap<Option<ChildInfo>, BTreeMap<StorageKey, StorageValue>>, StateVersion)
) -> Self
fn from(
(inner, state_version): (HashMap<Option<ChildInfo>, BTreeMap<StorageKey, StorageValue>>, StateVersion)
) -> Self
Converts to this type from the input type.
sourceimpl<H: Hasher, KF> From<(Storage, StateVersion)> for TrieBackend<GenericMemoryDB<H, KF>, H>where
H::Out: Codec + Ord,
KF: KeyFunction<H> + Send + Sync,
impl<H: Hasher, KF> From<(Storage, StateVersion)> for TrieBackend<GenericMemoryDB<H, KF>, H>where
H::Out: Codec + Ord,
KF: KeyFunction<H> + Send + Sync,
sourcefn from((inners, state_version): (Storage, StateVersion)) -> Self
fn from((inners, state_version): (Storage, StateVersion)) -> Self
Converts to this type from the input type.
sourceimpl<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,
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,
sourcefn from(
(inner, state_version): (Vec<(Option<ChildInfo>, StorageCollection)>, StateVersion)
) -> Self
fn from(
(inner, state_version): (Vec<(Option<ChildInfo>, StorageCollection)>, StateVersion)
) -> Self
Converts to this type from the input type.
Auto Trait Implementations
impl<S, H, C = LocalTrieCache<H>> !RefUnwindSafe for TrieBackend<S, H, C>
impl<S, H, C> Send for TrieBackend<S, H, C>where
C: Send,
impl<S, H, C> Sync for TrieBackend<S, H, C>where
C: Sync,
impl<S, H, C> Unpin for TrieBackend<S, H, C>where
C: Unpin,
S: Unpin,
<H as Hasher>::Out: Unpin,
impl<S, H, C = LocalTrieCache<H>> !UnwindSafe for TrieBackend<S, H, C>
Blanket Implementations
sourceimpl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>
fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>
Convert
Box<dyn Trait>
(where Trait: Downcast
) to Box<dyn Any>
. Box<dyn Any>
can
then be further downcast
into Box<ConcreteType>
where ConcreteType
implements Trait
. Read morefn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
Convert
Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
. Read morefn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
Convert
&Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
’s vtable from &Trait
’s. Read morefn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
Convert
&mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s. Read moresourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T, Outer> IsWrappedBy<Outer> for Twhere
Outer: AsRef<T> + AsMut<T> + From<T>,
T: From<Outer>,
impl<T, Outer> IsWrappedBy<Outer> for Twhere
Outer: AsRef<T> + AsMut<T> + From<T>,
T: From<Outer>,
impl<T> Pointable for T
impl<T> Pointable for T
sourceimpl<S, T> UncheckedInto<T> for Swhere
T: UncheckedFrom<S>,
impl<S, T> UncheckedInto<T> for Swhere
T: UncheckedFrom<S>,
sourcefn unchecked_into(self) -> T
fn unchecked_into(self) -> T
The counterpart to
unchecked_from
.