Struct safe_network::types::Cache

pub struct Cache<T, V> where
    T: Hash + Eq + Copy,  { /* fields omitted */ }

A BTreeMap-backed cache supporting capacity- and duration-based expiry.

Implementations

impl<T, V> Cache<T, V> where
    T: Ord + Hash + Copy, 

pub fn with_capacity(capacity: usize) -> Self

Creating capacity based Cache.

pub fn with_expiry_duration(duration: Duration) -> Self

Creating time based Cache.

pub fn with_expiry_duration_and_capacity(
    duration: Duration,
    capacity: usize
) -> Self

Creating dual-feature capacity and time based Cache.

pub async fn len(&self) -> usize

Returns the number of items in the cache.

pub async fn is_empty(&self) -> bool

Returns true if the cache contains no items.

pub async fn count<P>(&self, predicate: P) -> usize where
    P: FnMut(&(&T, &Item<V>)) -> bool, 

Returns the number of items in the cache that match the given predicate.

pub async fn get(&self, key: &T) -> Option<V> where
    T: Eq + Hash,
    V: Clone, 

Get a value from the cache if one is set and not expired.

A clone of the value is returned, so this is only implemented when V: Clone.

pub async fn set(
    &self,
    key: T,
    value: V,
    custom_duration: Option<Duration>
) -> Option<V> where
    T: Eq + Hash + Clone, 

Set a value in the cache and return the previous value, if any.

This will override an existing value for the same key, if there is one. custom_duration can be set to override self.item_duration. If the new item causes the cache to exceed its capacity, the oldest entry in the cache will be removed.

pub async fn remove_expired(&self)

Remove expired items from the cache storage.

pub async fn remove(&self, key: &T) -> Option<V> where
    T: Eq + Hash, 

Remove an item from the cache, returning the removed value.

pub async fn clear(&self)

Clear the cache, removing all items.

Trait Implementations

impl<T: Debug, V: Debug> Debug for Cache<T, V> where
    T: Hash + Eq + Copy, 

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

Formats the value using the given formatter.