Struct cosmwasm_storage::Singleton

pub struct Singleton<'a, T>
where
    T: Serialize + DeserializeOwned,
{ /* private fields */ }

👎Deprecated: The crate cosmwasm-storage is unmaintained and will be removed in CosmWasm 2.0. Please consider migrating to cw-storage-plus or simple cosmwasm-std storage calls.

Singleton effectively combines PrefixedStorage with TypedStorage to work on a single storage key. It performs the to_length_prefixed transformation on the given name to ensure no collisions, and then provides the standard TypedStorage accessors, without requiring a key (which is defined in the constructor)

Implementations

impl<'a, T> Singleton<'a, T>

where T: Serialize + DeserializeOwned,

pub fn new(storage: &'a mut dyn Storage, key: &[u8]) -> Self

pub fn save(&mut self, data: &T) -> StdResult<()>

save will serialize the model and store, returns an error on serialization issues

pub fn remove(&mut self)

pub fn load(&self) -> StdResult<T>

load will return an error if no data is set at the given key, or on parse error

pub fn may_load(&self) -> StdResult<Option<T>>

may_load will parse the data stored at the key if present, returns Ok(None) if no data there. returns an error on issues parsing

pub fn update<A, E>(&mut self, action: A) -> Result<T, E>

where A: FnOnce(T) -> Result<T, E>, E: From<StdError>,

update will load the data, perform the specified action, and store the result in the database. This is shorthand for some common sequences, which may be useful

This is the least stable of the APIs, and definitely needs some usage