Struct sp_state_machine::OverlayedChanges
source · pub struct OverlayedChanges<H: Hasher> { /* private fields */ }
Expand description
The set of changes that are overlaid onto the backend.
It allows changes to be modified using nestable transactions.
Implementations§
source§impl<H: Hasher> OverlayedChanges<H>
impl<H: Hasher> OverlayedChanges<H>
sourcepub fn is_empty(&self) -> bool
pub fn is_empty(&self) -> bool
Whether no changes are contained in the top nor in any of the child changes.
sourcepub fn set_collect_extrinsics(&mut self, collect_extrinsics: bool)
pub fn set_collect_extrinsics(&mut self, collect_extrinsics: bool)
Ask to collect/not to collect extrinsics indices where key(s) has been changed.
sourcepub fn storage(&self, key: &[u8]) -> Option<Option<&[u8]>>
pub fn storage(&self, key: &[u8]) -> Option<Option<&[u8]>>
Returns a double-Option: None if the key is unknown (i.e. and the query should be referred to the backend); Some(None) if the key has been deleted. Some(Some(…)) for a key whose value has been set.
sourcepub fn value_mut_or_insert_with(
&mut self,
key: &[u8],
init: impl Fn() -> StorageValue
) -> &mut StorageValue
pub fn value_mut_or_insert_with( &mut self, key: &[u8], init: impl Fn() -> StorageValue ) -> &mut StorageValue
Returns mutable reference to current value. If there is no value in the overlay, the given callback is used to initiate the value. Warning this function registers a change, so the mutable reference MUST be modified.
Can be rolled back or committed when called inside a transaction.
sourcepub fn child_storage(
&self,
child_info: &ChildInfo,
key: &[u8]
) -> Option<Option<&[u8]>>
pub fn child_storage( &self, child_info: &ChildInfo, key: &[u8] ) -> Option<Option<&[u8]>>
Returns a double-Option: None if the key is unknown (i.e. and the query should be referred to the backend); Some(None) if the key has been deleted. Some(Some(…)) for a key whose value has been set.
sourcepub fn set_storage(&mut self, key: StorageKey, val: Option<StorageValue>)
pub fn set_storage(&mut self, key: StorageKey, val: Option<StorageValue>)
Set a new value for the specified key.
Can be rolled back or committed when called inside a transaction.
sourcepub fn transaction_depth(&self) -> usize
pub fn transaction_depth(&self) -> usize
Returns the current nesting depth of the transaction stack.
A value of zero means that no transaction is open and changes are committed on write.
sourcepub fn start_transaction(&mut self)
pub fn start_transaction(&mut self)
Start a new nested transaction.
This allows to either commit or roll back all changes that where made while this
transaction was open. Any transaction must be closed by either rollback_transaction
or
commit_transaction
before this overlay can be converted into storage changes.
Changes made without any open transaction are committed immediately.
sourcepub fn rollback_transaction(&mut self) -> Result<(), NoOpenTransaction>
pub fn rollback_transaction(&mut self) -> Result<(), NoOpenTransaction>
Rollback the last transaction started by start_transaction
.
Any changes made during that transaction are discarded. Returns an error if there is no open transaction that can be rolled back.
sourcepub fn commit_transaction(&mut self) -> Result<(), NoOpenTransaction>
pub fn commit_transaction(&mut self) -> Result<(), NoOpenTransaction>
Commit the last transaction started by start_transaction
.
Any changes made during that transaction are committed. Returns an error if there is no open transaction that can be committed.
sourcepub fn enter_runtime(&mut self) -> Result<(), AlreadyInRuntime>
pub fn enter_runtime(&mut self) -> Result<(), AlreadyInRuntime>
Call this before transfering control to the runtime.
This protects all existing transactions from being removed by the runtime. Calling this while already inside the runtime will return an error.
sourcepub fn exit_runtime(&mut self) -> Result<(), NotInRuntime>
pub fn exit_runtime(&mut self) -> Result<(), NotInRuntime>
Call this when control returns from the runtime.
This commits all dangling transaction left open by the runtime. Calling this while outside the runtime will return an error.
sourcepub fn offchain_drain_committed(
&mut self
) -> impl Iterator<Item = ((StorageKey, StorageKey), OffchainOverlayedChange)>
pub fn offchain_drain_committed( &mut self ) -> impl Iterator<Item = ((StorageKey, StorageKey), OffchainOverlayedChange)>
Consume all changes (top + children) and return them.
After calling this function no more changes are contained in this changeset.
Panics:
Panics if transaction_depth() > 0
sourcepub fn children(
&self
) -> impl Iterator<Item = (impl Iterator<Item = (&StorageKey, &OverlayedEntry<Option<StorageValue>>)>, &ChildInfo)>
pub fn children( &self ) -> impl Iterator<Item = (impl Iterator<Item = (&StorageKey, &OverlayedEntry<Option<StorageValue>>)>, &ChildInfo)>
Get an iterator over all child changes as seen by the current transaction.
sourcepub fn changes(
&self
) -> impl Iterator<Item = (&StorageKey, &OverlayedEntry<Option<StorageValue>>)>
pub fn changes( &self ) -> impl Iterator<Item = (&StorageKey, &OverlayedEntry<Option<StorageValue>>)>
Get an iterator over all top changes as been by the current transaction.
sourcepub fn child_changes(
&self,
key: &[u8]
) -> Option<(impl Iterator<Item = (&StorageKey, &OverlayedEntry<Option<StorageValue>>)>, &ChildInfo)>
pub fn child_changes( &self, key: &[u8] ) -> Option<(impl Iterator<Item = (&StorageKey, &OverlayedEntry<Option<StorageValue>>)>, &ChildInfo)>
Get an optional iterator over all child changes stored under the supplied key.
sourcepub fn transaction_index_ops(&self) -> &[IndexOperation]
pub fn transaction_index_ops(&self) -> &[IndexOperation]
Get an list of all index operations.
sourcepub fn drain_storage_changes<B: Backend<H>>(
&mut self,
backend: &B,
state_version: StateVersion
) -> Result<StorageChanges<H>, DefaultError>where
H::Out: Ord + Encode + 'static,
pub fn drain_storage_changes<B: Backend<H>>( &mut self, backend: &B, state_version: StateVersion ) -> Result<StorageChanges<H>, DefaultError>where H::Out: Ord + Encode + 'static,
Drain all changes into a StorageChanges
instance. Leave empty overlay in place.
sourcepub fn storage_root<B: Backend<H>>(
&mut self,
backend: &B,
state_version: StateVersion
) -> (H::Out, bool)where
H::Out: Ord + Encode,
pub fn storage_root<B: Backend<H>>( &mut self, backend: &B, state_version: StateVersion ) -> (H::Out, bool)where H::Out: Ord + Encode,
Generate the storage root using backend
and all changes
as seen by the current transaction.
Returns the storage root and whether it was already cached.
sourcepub fn child_storage_root<B: Backend<H>>(
&mut self,
child_info: &ChildInfo,
backend: &B,
state_version: StateVersion
) -> Result<(H::Out, bool), B::Error>where
H::Out: Ord + Encode + Decode,
pub fn child_storage_root<B: Backend<H>>( &mut self, child_info: &ChildInfo, backend: &B, state_version: StateVersion ) -> Result<(H::Out, bool), B::Error>where H::Out: Ord + Encode + Decode,
Generate the child storage root using backend
and all child changes
as seen by the current transaction.
Returns the child storage root and whether it was already cached.
sourcepub fn iter_after(
&self,
key: &[u8]
) -> impl Iterator<Item = (&[u8], &OverlayedEntry<Option<StorageValue>>)>
pub fn iter_after( &self, key: &[u8] ) -> impl Iterator<Item = (&[u8], &OverlayedEntry<Option<StorageValue>>)>
Returns an iterator over the keys (in lexicographic order) following key
(excluding key
)
alongside its value.
sourcepub fn child_iter_after(
&self,
storage_key: &[u8],
key: &[u8]
) -> impl Iterator<Item = (&[u8], &OverlayedEntry<Option<StorageValue>>)>
pub fn child_iter_after( &self, storage_key: &[u8], key: &[u8] ) -> impl Iterator<Item = (&[u8], &OverlayedEntry<Option<StorageValue>>)>
Returns an iterator over the keys (in lexicographic order) following key
(excluding key
)
alongside its value for the given storage_key
child.
sourcepub fn offchain(&self) -> &OffchainOverlayedChanges
pub fn offchain(&self) -> &OffchainOverlayedChanges
Read only access ot offchain overlay.
sourcepub fn set_offchain_storage(&mut self, key: &[u8], value: Option<&[u8]>)
pub fn set_offchain_storage(&mut self, key: &[u8], value: Option<&[u8]>)
Write a key value pair to the offchain storage overlay.
sourcepub fn add_transaction_index(&mut self, op: IndexOperation)
pub fn add_transaction_index(&mut self, op: IndexOperation)
Add transaction index operation.
Trait Implementations§
source§impl<H: Hasher> Clone for OverlayedChanges<H>
impl<H: Hasher> Clone for OverlayedChanges<H>
source§impl<H: Hasher> Debug for OverlayedChanges<H>
impl<H: Hasher> Debug for OverlayedChanges<H>
source§impl<H: Hasher> Default for OverlayedChanges<H>
impl<H: Hasher> Default for OverlayedChanges<H>
Auto Trait Implementations§
impl<H> !RefUnwindSafe for OverlayedChanges<H>
impl<H> Send for OverlayedChanges<H>
impl<H> !Sync for OverlayedChanges<H>
impl<H> Unpin for OverlayedChanges<H>where H: Unpin, <H as Hasher>::Out: Unpin,
impl<H> UnwindSafe for OverlayedChanges<H>where H: UnwindSafe, <H as Hasher>::Out: UnwindSafe,
Blanket Implementations§
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<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
source§impl<S, T> UncheckedInto<T> for Swhere
T: UncheckedFrom<S>,
impl<S, T> UncheckedInto<T> for Swhere T: UncheckedFrom<S>,
source§fn unchecked_into(self) -> T
fn unchecked_into(self) -> T
unchecked_from
.