Struct cached::UnboundCache

pub struct UnboundCache<K, V> { /* fields omitted */ }

Default unbounded cache

This cache has no size limit or eviction policy.

Note: This cache is in-memory only

Implementations

impl<K: Hash + Eq, V> UnboundCache<K, V>

pub fn new() -> UnboundCache<K, V>

Creates an empty UnboundCache

pub fn with_capacity(size: usize) -> UnboundCache<K, V>

Creates an empty UnboundCache with a given pre-allocated capacity

Trait Implementations

impl<K: Hash + Eq, V> Cached<K, V> for UnboundCache<K, V>

pub fn cache_get(&mut self, key: &K) -> Option<&V>

Attempt to retrieve a cached value

pub fn cache_get_mut(&mut self, key: &K) -> Option<&mut V>

Attempt to retrieve a cached value with mutable access

pub fn cache_set(&mut self, key: K, val: V) -> Option<V>

Insert a key, value pair and return the previous value

pub fn cache_get_or_set_with<F: FnOnce() -> V>(
    &mut self,
    key: K,
    f: F
) -> &mut V

Get or insert a key, value pair

pub fn cache_remove(&mut self, k: &K) -> Option<V>

Remove a cached value

pub fn cache_clear(&mut self)

Remove all cached values. Keeps the allocated memory for reuse.

pub fn cache_reset(&mut self)

Remove all cached values. Free memory and return to initial state

pub fn cache_size(&self) -> usize

Return the current cache size (number of elements)

pub fn cache_hits(&self) -> Option<u64>

Return the number of times a cached value was successfully retrieved

pub fn cache_misses(&self) -> Option<u64>

Return the number of times a cached value was unable to be retrieved

pub fn cache_capacity(&self) -> Option<usize>

Return the cache capacity

pub fn cache_lifespan(&self) -> Option<u64>

Return the lifespan of cached values (time to eviction)

pub fn cache_set_lifespan(&mut self, _seconds: u64) -> Option<u64>

Set the lifespan of cached values, returns the old value

impl<K, V> CachedAsync<K, V> for UnboundCache<K, V> where
    K: Hash + Eq + Clone + Send, 

pub fn get_or_set_with<'life0, 'async_trait, F, Fut>(
    &'life0 mut self,
    key: K,
    f: F
) -> Pin<Box<dyn Future<Output = &mut V> + Send + 'async_trait>> where
    V: Send,
    F: FnOnce() -> Fut + Send,
    Fut: Future<Output = V> + Send,
    F: 'async_trait,
    Fut: 'async_trait,
    'life0: 'async_trait,
    Self: 'async_trait, 

pub fn try_get_or_set_with<'life0, 'async_trait, F, Fut, E>(
    &'life0 mut self,
    key: K,
    f: F
) -> Pin<Box<dyn Future<Output = Result<&mut V, E>> + Send + 'async_trait>> where
    V: Send,
    F: FnOnce() -> Fut + Send,
    Fut: Future<Output = Result<V, E>> + Send,
    F: 'async_trait,
    Fut: 'async_trait,
    E: 'async_trait,
    'life0: 'async_trait,
    Self: 'async_trait, 

impl<K: Clone, V: Clone> Clone for UnboundCache<K, V>

pub fn clone(&self) -> UnboundCache<K, V>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<K: Debug, V: Debug> Debug for UnboundCache<K, V>

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

Formats the value using the given formatter.

impl<K, V> Eq for UnboundCache<K, V> where
    K: Eq + Hash,
    V: PartialEq, 

impl<K, V> PartialEq<UnboundCache<K, V>> for UnboundCache<K, V> where
    K: Eq + Hash,
    V: PartialEq, 

pub fn eq(&self, other: &UnboundCache<K, V>) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.