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>

source

pub fn is_empty(&self) -> bool

Whether no changes are contained in the top nor in any of the child changes.

source

pub fn set_collect_extrinsics(&mut self, collect_extrinsics: bool)

Ask to collect/not to collect extrinsics indices where key(s) has been changed.

source

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.

source

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.

source

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.

source

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.

source

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.

source

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.

source

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.

source

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.

source

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.

source

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.

source

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

source

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.

source

pub fn changes( &self ) -> impl Iterator<Item = (&StorageKey, &OverlayedEntry<Option<StorageValue>>)>

Get an iterator over all top changes as been by the current transaction.

source

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.

source

pub fn transaction_index_ops(&self) -> &[IndexOperation]

Get an list of all index operations.

source

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.

source

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.

source

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.

source

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.

source

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.

source

pub fn offchain(&self) -> &OffchainOverlayedChanges

Read only access ot offchain overlay.

source

pub fn set_offchain_storage(&mut self, key: &[u8], value: Option<&[u8]>)

Write a key value pair to the offchain storage overlay.

source

pub fn add_transaction_index(&mut self, op: IndexOperation)

Add transaction index operation.

Trait Implementations§

source§

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

source§

fn clone(&self) -> Self

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl<H: Hasher> Debug for OverlayedChanges<H>

source§

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

Formats the value using the given formatter. Read more
source§

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

source§

fn default() -> Self

Returns the “default value” for a type. Read more
source§

impl<H: Hasher> From<Storage> for OverlayedChanges<H>

source§

fn from(storage: Storage) -> Self

Converts to this type from the input type.

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> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

const: unstable · source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

const: unstable · source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> DynClone for Twhere T: Clone,

source§

fn __clone_box(&self, _: Private) -> *mut ()

source§

impl<T> From<T> for T

const: unstable · source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for Twhere U: From<T>,

const: unstable · source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T, Outer> IsWrappedBy<Outer> for Twhere Outer: AsRef<T> + AsMut<T> + From<T>, T: From<Outer>,

source§

fn from_ref(outer: &Outer) -> &T

Get a reference to the inner from the outer.

source§

fn from_mut(outer: &mut Outer) -> &mut T

Get a mutable reference to the inner from the outer.

§

impl<T> Pointable for T

§

const ALIGN: usize = mem::align_of::<T>()

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
source§

impl<T> Same<T> for T

§

type Output = T

Should always be Self
source§

impl<T> ToOwned for Twhere T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
const: unstable · source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
const: unstable · source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<S, T> UncheckedInto<T> for Swhere T: UncheckedFrom<S>,

source§

fn unchecked_into(self) -> T

The counterpart to unchecked_from.
§

impl<V, T> VZip<V> for Twhere V: MultiLane<T>,

§

fn vzip(self) -> V

source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
§

impl<T> JsonSchemaMaybe for T

§

impl<T> MaybeDebug for Twhere T: Debug,