Struct dharitri_wasm::storage::mappers::SingleValueMapper

pub struct SingleValueMapper<SA, T>
where
    SA: StorageMapperApi,
    T: TopEncode + TopDecode + 'static,
{ /* private fields */ }

Manages a single serializable item in storage.

Implementations

impl<SA, T> SingleValueMapper<SA, T>

where SA: StorageMapperApi, T: TopEncode + TopDecode,

pub fn get(&self) -> T

Retrieves current value from storage.

pub fn is_empty(&self) -> bool

Returns whether the storage managed by this mapper is empty.

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

where BT: Borrow<T>,

Saves argument to storage.

Accepts owned item of type T, or any borrowed form of it, such as &T.

pub fn set_if_empty(&self, value: &T)

Saves argument to storage only if the storage is empty. Does nothing otherwise.

pub fn clear(&self)

Clears the storage for this mapper.

pub fn update<R, F: FnOnce(&mut T) -> R>(&self, f: F) -> R

Syntactic sugar, to more compactly express a get, update and set in one line. Takes whatever lies in storage, apples the given closure and saves the final value back to storage. Propagates the return value of the given function.

pub fn raw_byte_length(&self) -> usize

Trait Implementations

impl<SA, T> EndpointResult for SingleValueMapper<SA, T>

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

type DecodeAs = <T as EndpointResult>::DecodeAs

Indicates how the result of the endpoint can be interpreted when called via proxy. Self for most types.

fn finish<FA>(&self)

where FA: ManagedTypeApi + EndpointFinishApi,

impl<SA, T> StorageMapper<SA> for SingleValueMapper<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> TypeAbi for SingleValueMapper<SA, T>

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

fn type_name() -> TypeName

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

A type can provide more than its own description. 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.