Struct cw_storage_plus::Map

pub struct Map<K, T> { /* private fields */ }

Implementations

impl<K, T> Map<K, T>

pub const fn new(namespace: &'static str) -> Self

Creates a new Map with the given storage key. This is a const fn only suitable when you have the storage key in the form of a static string slice.

pub fn new_dyn(namespace: impl Into<Namespace>) -> Self

Creates a new Map with the given storage key. Use this if you might need to handle a dynamic string. Otherwise, you might prefer Map::new.

pub fn namespace_bytes(&self) -> &[u8]

impl<'a, K, T> Map<K, T>

where T: Serialize + DeserializeOwned, K: PrimaryKey<'a>,

pub fn key(&self, k: K) -> Path<T>

pub fn save(&self, store: &mut dyn Storage, k: K, data: &T) -> StdResult<()>

pub fn remove(&self, store: &mut dyn Storage, k: K)

pub fn load(&self, store: &dyn Storage, k: K) -> 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, store: &dyn Storage, k: K) -> 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 has(&self, store: &dyn Storage, k: K) -> bool

has returns true or false if any data is at this key, without parsing or interpreting the contents.

pub fn update<A, E>( &self, store: &mut dyn Storage, k: K, action: A ) -> Result<T, E>

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

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

If the data exists, action(Some(value)) is called. Otherwise action(None) is called.

pub fn query<Q: CustomQuery>( &self, querier: &QuerierWrapper<'_, Q>, remote_contract: Addr, k: K ) -> StdResult<Option<T>>

If you import the proper Map from the remote contract, this will let you read the data from a remote contract in a type-safe way using WasmQuery::RawQuery

pub fn clear(&self, store: &mut dyn Storage)

Clears the map, removing all elements.

pub fn is_empty(&self, store: &dyn Storage) -> bool

Returns true if the map is empty.

impl<'a, K, T> Map<K, T>

where T: Serialize + DeserializeOwned, K: PrimaryKey<'a>,

pub fn sub_prefix( &self, p: K::SubPrefix ) -> Prefix<K::SuperSuffix, T, K::SuperSuffix>

pub fn prefix(&self, p: K::Prefix) -> Prefix<K::Suffix, T, K::Suffix>

impl<'a, K, T> Map<K, T>

where T: Serialize + DeserializeOwned, K: PrimaryKey<'a>,

pub fn prefix_range_raw<'c>( &self, store: &'c dyn Storage, min: Option<PrefixBound<'a, K::Prefix>>, max: Option<PrefixBound<'a, K::Prefix>>, order: Order ) -> Box<dyn Iterator<Item = StdResult<Record<T>>> + 'c>

where T: 'c, 'a: 'c,

While range_raw over a prefix fixes the prefix to one element and iterates over the remaining, prefix_range_raw accepts bounds for the lowest and highest elements of the Prefix itself, and iterates over those (inclusively or exclusively, depending on PrefixBound). There are some issues that distinguish these two, and blindly casting to Vec<u8> doesn’t solve them.

impl<'a, K, T> Map<K, T>

where T: Serialize + DeserializeOwned, K: PrimaryKey<'a> + KeyDeserialize,

pub fn prefix_range<'c>( &self, store: &'c dyn Storage, min: Option<PrefixBound<'a, K::Prefix>>, max: Option<PrefixBound<'a, K::Prefix>>, order: Order ) -> Box<dyn Iterator<Item = StdResult<(K::Output, T)>> + 'c>

where T: 'c, K: 'c, K::Output: 'static, 'a: 'c,

While range over a prefix fixes the prefix to one element and iterates over the remaining, prefix_range accepts bounds for the lowest and highest elements of the Prefix itself, and iterates over those (inclusively or exclusively, depending on PrefixBound). There are some issues that distinguish these two, and blindly casting to Vec<u8> doesn’t solve them.

impl<'a, K, T> Map<K, T>

where T: Serialize + DeserializeOwned, K: PrimaryKey<'a>,

pub fn range_raw<'c>( &self, store: &'c dyn Storage, min: Option<Bound<'a, K>>, max: Option<Bound<'a, K>>, order: Order ) -> Box<dyn Iterator<Item = StdResult<Record<T>>> + 'c>

where T: 'c,

pub fn keys_raw<'c>( &self, store: &'c dyn Storage, min: Option<Bound<'a, K>>, max: Option<Bound<'a, K>>, order: Order ) -> Box<dyn Iterator<Item = Vec<u8>> + 'c>

where T: 'c,

impl<'a, K, T> Map<K, T>

where T: Serialize + DeserializeOwned, K: PrimaryKey<'a> + KeyDeserialize,

pub fn range<'c>( &self, store: &'c dyn Storage, min: Option<Bound<'a, K>>, max: Option<Bound<'a, K>>, order: Order ) -> Box<dyn Iterator<Item = StdResult<(K::Output, T)>> + 'c>

where T: 'c, K::Output: 'static,

pub fn keys<'c>( &self, store: &'c dyn Storage, min: Option<Bound<'a, K>>, max: Option<Bound<'a, K>>, order: Order ) -> Box<dyn Iterator<Item = StdResult<K::Output>> + 'c>

where T: 'c, K::Output: 'static,

pub fn first(&self, storage: &dyn Storage) -> StdResult<Option<(K::Output, T)>>

where K::Output: 'static,

Returns the first key-value pair in the map. This is not according to insertion-order, but according to the key ordering.

Examples

const MAP: Map<i32, u32> = Map::new("map");

// empty map
assert_eq!(MAP.first(&storage), Ok(None));

// insert entries
MAP.save(&mut storage, 1, &10).unwrap();
MAP.save(&mut storage, -2, &20).unwrap();

assert_eq!(MAP.first(&storage), Ok(Some((-2, 20))));

pub fn last(&self, storage: &dyn Storage) -> StdResult<Option<(K::Output, T)>>

where K::Output: 'static,

Returns the last key-value pair in the map. This is not according to insertion-order, but according to the key ordering.

Examples

const MAP: Map<i32, u32> = Map::new("map");

// empty map
assert_eq!(MAP.last(&storage), Ok(None));

// insert entries
MAP.save(&mut storage, 1, &10).unwrap();
MAP.save(&mut storage, -2, &20).unwrap();

assert_eq!(MAP.last(&storage), Ok(Some((1, 10))));

Trait Implementations

impl<K: Clone, T: Clone> Clone for Map<K, T>

fn clone(&self) -> Map<K, T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<K: Debug, T: Debug> Debug for Map<K, T>

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

Formats the value using the given formatter.