Struct dock_core::util::with_nonce::WithNonce

pub struct WithNonce<T: Types, D> {
    pub nonce: T::BlockNumber,
    /* private fields */
}

Wrapper for any kind of entity with a nonce. Nonces are mostly used for replay protection. Initial nonce will be equal to the current block number provided by the system.

Fields

nonce: T::BlockNumber

Implementations

impl<T: Types, D> WithNonce<T, D>

pub fn new(data: D) -> Selfwhere T: Config<BlockNumber = <T as Types>::BlockNumber>,

Adds a nonce to the given data. Nonce will be equal to the current block number provided by the system.

pub fn new_with_nonce(data: D, nonce: T::BlockNumber) -> Self

Adds supplied nonce to the given data.

pub fn data(&self) -> &D

Returns read-only reference to the underlying data.

pub fn into_data(self) -> D

Takes underlying data. If you would like to update an entity, use try_update instead.

pub fn next_nonce(&self) -> Option<T::BlockNumber>

Returns next nonce for the given entity.

pub fn is_next_nonce(&self, nonce: T::BlockNumber) -> bool

Returns true if given nonce is the next nonce for the given entity, i.e. is equal to current nonce plus 1.

pub fn try_update(&mut self, nonce: T::BlockNumber) -> Result<&mut D, NonceError>

Returns mutable reference to the underlying data if provided nonce is equal to current nonce plus 1, otherwise returns an error.

pub fn try_update_opt_with<F, E, R>( this_opt: &mut Option<Self>, nonce: T::BlockNumber, f: F ) -> Option<Result<R, E>>where F: FnOnce(&mut Option<D>) -> Result<R, E>, E: From<NonceError>,

If supplied value is Some(_), attempts to increase current nonce - succeeds if provided nonce is equal to current nonce plus 1, otherwise returns an error. If value is None, None will be returned.

pub fn try_update_opt_without_increasing_nonce_with<F, E, R>( this_opt: &mut Option<Self>, f: F ) -> Option<Result<R, E>>where F: FnOnce(&mut Option<D>) -> Result<R, E>,

If supplied value is Some(_), will update given entity without increasing nonce.

Trait Implementations

impl<T: Clone + Types, D: Clone> Clone for WithNonce<T, D>where T::BlockNumber: Clone,

fn clone(&self) -> WithNonce<T, D>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Types, D: Debug> Debug for WithNonce<T, D>

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

Formats the value using the given formatter.

impl<T: Types, D> Decode for WithNonce<T, D>where T::BlockNumber: Decode, D: Decode,

fn decode<__CodecInputEdqy: Input>( __codec_input_edqy: &mut __CodecInputEdqy ) -> Result<Self, Error>

Attempt to deserialise the value from input.

fn decode_into<I>( input: &mut I, dst: &mut MaybeUninit<Self> ) -> Result<DecodeFinished, Error>where I: Input,

Attempt to deserialize the value from input into a pre-allocated piece of memory.

fn skip<I>(input: &mut I) -> Result<(), Error>where I: Input,

Attempt to skip the encoded value from input.

fn encoded_fixed_size() -> Option<usize>

Returns the fixed encoded size of the type.

impl<'de, T, D> Deserialize<'de> for WithNonce<T, D>where T: Sized + Types, D: Deserialize<'de>,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T: Types, D> Encode for WithNonce<T, D>where D: Encode,

fn size_hint(&self) -> usize

If possible give a hint of expected size of the encoding.

fn encode_to<__CodecOutputEdqy: Output + ?Sized>( &self, __codec_dest_edqy: &mut __CodecOutputEdqy )

Convert self to a slice and append it to the destination.

fn encode(&self) -> Vec<u8, Global>

Convert self to an owned vector.

fn using_encoded<R, F>(&self, f: F) -> Rwhere F: FnOnce(&[u8]) -> R,

Convert self to a slice and then invoke the given closure with it.

fn encoded_size(&self) -> usize

Calculates the encoded size.

impl<T: Config> From<StoredDidDetails<T>> for WithNonce<T, DidDetailsOrDidMethodKeyDetails<T>>

fn from(details: StoredDidDetails<T>) -> Self

Converts to this type from the input type.

impl<T: Config> From<WithNonce<T, ()>> for WithNonce<T, DidDetailsOrDidMethodKeyDetails<T>>

fn from(this: WithNonce<T, ()>) -> Self

Converts to this type from the input type.

impl<T: TypesAndLimits> From<WithNonce<T, OnChainDidDetails>> for StoredDidDetails<T>

fn from(details: StoredOnChainDidDetails<T>) -> Self

Converts to this type from the input type.

impl<T: Types, D: MaxEncodedLen> MaxEncodedLen for WithNonce<T, D>

fn max_encoded_len() -> usize

Upper bound, in bytes, of the maximum encoded size of this item.

impl<T: PartialEq + Types, D: PartialEq> PartialEq<WithNonce<T, D>> for WithNonce<T, D>where T::BlockNumber: PartialEq,

fn eq(&self, other: &WithNonce<T, D>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T, D> Serialize for WithNonce<T, D>where T: Sized + Types, D: Serialize,

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<T: Config> TryFrom<WithNonce<T, DidDetailsOrDidMethodKeyDetails<T>>> for StoredDidDetails<T>

type Error = Error<T>

The type returned in the event of a conversion error.

fn try_from( details: WithNonce<T, DidDetailsOrDidMethodKeyDetails<T>> ) -> Result<Self, Self::Error>

Performs the conversion.

impl<T: Config> TryFrom<WithNonce<T, DidDetailsOrDidMethodKeyDetails<T>>> for StoredOnChainDidDetails<T>

type Error = Error<T>

The type returned in the event of a conversion error.

fn try_from( details: WithNonce<T, DidDetailsOrDidMethodKeyDetails<T>> ) -> Result<Self, Self::Error>

Performs the conversion.

impl<T: Config> TryFrom<WithNonce<T, DidDetailsOrDidMethodKeyDetails<T>>> for WithNonce<T, ()>

type Error = Error<T>

The type returned in the event of a conversion error.

fn try_from( details: WithNonce<T, DidDetailsOrDidMethodKeyDetails<T>> ) -> Result<Self, Self::Error>

Performs the conversion.

impl<T: Config> TryFrom<WithNonce<T, OnChainDidDetails>> for WithNonce<T, DidDetailsOrDidMethodKeyDetails<T>>

type Error = Error<T>

The type returned in the event of a conversion error.

fn try_from(details: StoredOnChainDidDetails<T>) -> Result<Self, Self::Error>

Performs the conversion.

impl<T, D> TypeInfo for WithNonce<T, D>where T::BlockNumber: TypeInfo + 'static, D: TypeInfo + 'static, T: Types + 'static,

type Identity = WithNonce<T, D>

The type identifying for which type info is provided.

fn type_info() -> Type

Returns the static type identifier for Self.

impl<T: Types, D> EncodeLike<WithNonce<T, D>> for WithNonce<T, D>where D: Encode,

impl<T: Eq + Types, D: Eq> Eq for WithNonce<T, D>where T::BlockNumber: Eq,

impl<T: Types, D> StructuralEq for WithNonce<T, D>

impl<T: Types, D> StructuralPartialEq for WithNonce<T, D>