Struct Keymap 

pub struct Keymap<'a, K, T, Ser = Bincode2, I = WithIter>
where
    K: Serialize + DeserializeOwned,
    T: Serialize + DeserializeOwned,
    Ser: Serde,
    I: IterOption,
{ /* private fields */ }

Implementations

impl<'a, K: Serialize + DeserializeOwned, T: Serialize + DeserializeOwned, Ser: Serde> Keymap<'a, K, T, Ser>

pub const fn new(namespace: &'a [u8]) -> Self

constructor

pub fn add_suffix(&self, suffix: &[u8]) -> Self

This is used to produce a new Keymap. This can be used when you want to associate an Keymap to each user and you still get to define the Keymap as a static constant

impl<K: Serialize + DeserializeOwned, T: Serialize + DeserializeOwned, Ser: Serde> Keymap<'_, K, T, Ser, WithoutIter>

pub fn get(&self, storage: &dyn Storage, key: &K) -> Option<T>

user facing get function

pub fn remove(&self, storage: &mut dyn Storage, key: &K) -> StdResult<()>

user facing remove function

pub fn insert( &self, storage: &mut dyn Storage, key: &K, item: &T, ) -> StdResult<()>

user facing insert function

pub fn contains(&self, storage: &dyn Storage, key: &K) -> bool

user facing method that checks if any item is stored with this key.

impl<'a, K: Serialize + DeserializeOwned, T: Serialize + DeserializeOwned, Ser: Serde> Keymap<'a, K, T, Ser, WithIter>

pub fn get_len(&self, storage: &dyn Storage) -> StdResult<u32>

get total number of objects saved

pub fn is_empty(&self, storage: &dyn Storage) -> StdResult<bool>

checks if the collection has any elements

pub fn get(&self, storage: &dyn Storage, key: &K) -> Option<T>

user facing get function

pub fn remove(&self, storage: &mut dyn Storage, key: &K) -> StdResult<()>

user facing remove function

pub fn insert( &self, storage: &mut dyn Storage, key: &K, item: &T, ) -> StdResult<()>

user facing insert function

pub fn contains(&self, storage: &dyn Storage, key: &K) -> bool

user facing method that checks if any item is stored with this key.

pub fn paging( &self, storage: &dyn Storage, start_page: u32, size: u32, ) -> StdResult<Vec<(K, T)>>

paginates (key, item) pairs.

pub fn paging_keys( &self, storage: &dyn Storage, start_page: u32, size: u32, ) -> StdResult<Vec<K>>

paginates only the keys. More efficient than paginating both items and keys

pub fn iter_keys( &self, storage: &'a dyn Storage, ) -> StdResult<KeyIter<'_, K, T, Ser>>

Returns a readonly iterator only for keys. More efficient than iter().

pub fn iter( &self, storage: &'a dyn Storage, ) -> StdResult<KeyItemIter<'_, K, T, Ser>>

Returns a readonly iterator for (key-item) pairs