Struct sp_runtime::offchain::storage_lock::StorageLock[][src]

pub struct StorageLock<'a, L = Time> { /* fields omitted */ }
Expand description

Storage based lock.

A lock that is persisted in the DB and provides the ability to guard against concurrent access in an off-chain worker, with a defined expiry deadline based on the concrete Lockable implementation.

Implementations

Create a new storage lock with a default() instance of type L.

Create a new storage lock with an explicit instance of a lockable L.

A single attempt to lock using the storage entry.

Returns a lock guard on success, otherwise an error containing the <Self::Lockable>::Deadline in for the currently active lock by another task Err(<L as Lockable>::Deadline).

Repeated lock attempts until the lock is successfully acquired.

If one uses fn forget(..), it is highly likely fn try_lock(..) is the correct API to use instead of fn lock(..), since that might never unlock in the anticipated span i.e. when used with BlockAndTime during a certain block number span.

Explicitly create a time based storage lock with a non-default expiration timeout.

Explicitly create a time and block number based storage lock with a non-default expiration duration and block number offset.

Explicitly create a time and block number based storage lock with the default expiration duration and a non-default block number offset.

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

Convert from a value of T into an equivalent instance of Option<Self>. Read more

Consume self to return Some equivalent value of Option<T>. Read more

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 more

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait. Read more

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s. Read more

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s. Read more

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait. Read more

Performs the conversion.

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

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

Performs the conversion.

Get a reference to the inner from the outer.

Get a mutable reference to the inner from the outer.

Should always be Self

Convert from a value of T into an equivalent instance of Self. Read more

Consume self to return an equivalent value of T. Read more

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.

The counterpart to unchecked_from.

Consume self to return an equivalent value of T.