Struct common::cache_storage::cache_map::CacheStorageMap

pub struct CacheStorageMap<Key, Value, Storage>where
    Key: Ord + FullEncode + Clone,
    Value: FullCodec + Clone + PartialEq,
    Storage: StorageMap<Key, Value>,{ /* private fields */ }

CacheStorageMap is a wrapper of StorageMap that follows the idea one read, one write the same data.

Implementations

impl<Key, Value, Storage> CacheStorageMap<Key, Value, Storage>where Key: Ord + FullEncode + Clone, Value: FullCodec + Clone + PartialEq, Storage: StorageMap<Key, Value>,

pub fn new() -> Self

pub fn contains_key(&self, key: &Key) -> bool

pub fn get(&mut self, key: &Key) -> Option<&Value>

Returns the cached value if it is, otherwise tries to get the value from Storage. If Storage has the value, CacheStorageMap caches it and returns. If Storage has no the value, the None is kept and returned.

When client calls get with the same key again, the cached value or None is returned without trying to get it from Storage.

pub fn set(&mut self, key: Key, value: Value)

Sets the value and mark it as Updated

pub fn remove(&mut self, key: &Key)

Marks the cached value as Removed. Now the None will be returned for get with the same key If there is no this cached value, then None is kept or Removed if Storage contains it.

pub fn commit(&mut self)

Syncs all the data with Storage. Inserts in Storage all values are marked as Updated and marks them as Original. Removes from Storage all values are marked as Removed. Does nothing with Original values. And then removes all non-Original values.

pub fn reset(&mut self)

Resets the cache