Struct TimelockMapper

pub struct TimelockMapper<SA, T, A = CurrentStorage>
where
    SA: StorageMapperApi,
    A: StorageAddress<SA>,
    T: TopEncode + TopDecode + 'static,
{ /* private fields */ }

Implementations

impl<SA, T> TimelockMapper<SA, T>

where SA: StorageMapperApi + BlockchainApi, T: TopEncode + TopDecode,

pub fn set<BT>(&self, new_current_value: BT)

where BT: Borrow<T>,

Sets the current value without taking into account the timelock component. Meant to be used in constructors.

pub fn commit(&self) -> bool

Updates current value entry with future value if unlock timestamp has passed.

pub fn set_unlock_timestamp<BT>(&self, unlock_timestamp: u64, future_value: BT)

where BT: Borrow<T>,

Sets a value and an unlock timestamp for the value. Setup needs to be commited after the unlock timestamp has passed. Unlock timestamp represents the moment in time when the future value can be updated as current value.

impl<SA, T, A> TimelockMapper<SA, T, A>

where SA: StorageMapperApi, T: TopEncode + TopDecode, A: StorageAddress<SA>,

pub fn get(&self) -> T

Retrieves the current value from storage.

pub fn get_unlock_timestamp(&self) -> u64

Retrieves the unlock timestamp from storage.

pub fn get_future_value(&self) -> T

Retrieves the future value from storage.

Trait Implementations

impl<SA, T> StorageMapper<SA> for TimelockMapper<SA, T>

where SA: StorageMapperApi, T: TopEncode + TopDecode,

fn new(base_key: StorageKey<SA>) -> Self

Will be called automatically by the #[storage_mapper] annotation generated code.

impl<SA, T> StorageMapperFromAddress<SA> for TimelockMapper<SA, T, ManagedAddress<SA>>

where SA: StorageMapperApi, T: TopEncode + TopDecode,

fn new_from_address( address: ManagedAddress<SA>, base_key: StorageKey<SA>, ) -> Self

Will be called automatically by the #[storage_mapper_from_address] annotation generated code.

impl<SA, T> TopEncodeMulti for TimelockMapper<SA, T>

where SA: StorageMapperApi, T: TopEncode + TopDecode,

fn multi_encode_or_handle_err<O, H>( &self, output: &mut O, h: H, ) -> Result<(), H::HandledErr>

where O: TopEncodeMultiOutput, H: EncodeErrorHandler,

Version of top_encode that can handle errors as soon as they occur. For instance in can exit immediately and make sure that if it returns, it is a success. By not deferring error handling, this can lead to somewhat smaller bytecode.

fn multi_encode<O>(&self, output: &mut O) -> Result<(), EncodeError>

where O: TopEncodeMultiOutput,

Attempt to serialize the value to ouput.

impl<SA, T> TypeAbi for TimelockMapper<SA, T>

where SA: StorageMapperApi, T: TopEncode + TopDecode + TypeAbi,

type Unmanaged = <T as TypeAbi>::Unmanaged

fn type_name() -> TypeName

fn type_name_rust() -> TypeName

fn provide_type_descriptions<TDC: TypeDescriptionContainer>( accumulator: &mut TDC, )

A type can provide more than its own name. For instance, a struct can also provide the descriptions of the type of its fields. TypeAbi doesn’t care for the exact accumulator type, which is abstracted by the TypeDescriptionContainer trait.

fn type_names() -> TypeNames

impl<SA, T> TypeAbiFrom<TimelockMapper<SA, T>> for PlaceholderOutput

where SA: StorageMapperApi, T: TopEncode + TopDecode,

impl<SA, T, R> TypeAbiFrom<TimelockMapper<SA, T>> for SingleValue<R>

where SA: StorageMapperApi, T: TopEncode + TopDecode, R: TopDecode + TypeAbiFrom<T>,

impl<SA, T> TypeAbiFrom<TimelockMapper<SA, T>> for TimelockMapper<SA, T>

where SA: StorageMapperApi, T: TopEncode + TopDecode + TypeAbi,