Struct cached::stores::TimedCache

pub struct TimedCache<K, V> { /* private fields */ }

Cache store bound by time

Values are timestamped when inserted and are evicted if expired at time of retrieval.

Note: This cache is in-memory only

Implementations

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

pub fn with_lifespan(seconds: u64) -> TimedCache<K, V>

Creates a new TimedCache with a specified lifespan

pub fn with_lifespan_and_capacity(seconds: u64, size: usize) -> TimedCache<K, V>

Creates a new TimedCache with a specified lifespan and cache-store with the specified pre-allocated capacity

pub fn with_lifespan_and_refresh( seconds: u64, refresh: bool ) -> TimedCache<K, V>

Creates a new TimedCache with a specified lifespan which refreshes the ttl when the entry is retrieved

pub fn refresh(&self) -> bool

Returns if the lifetime is refreshed when the value is retrieved

pub fn set_refresh(&mut self, refresh: bool)

Sets if the lifetime is refreshed when the value is retrieved

pub fn get_store(&self) -> &HashMap<K, (Instant, V)>

Returns a reference to the cache’s store

pub fn flush(&mut self)

Remove any expired values from the cache

Trait Implementations

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

fn cache_get<Q>(&mut self, key: &Q) -> Option<&V>where K: Borrow<Q>, Q: Hash + Eq + ?Sized,

Attempt to retrieve a cached value

fn cache_get_mut<Q>(&mut self, key: &Q) -> Option<&mut V>where K: Borrow<Q>, Q: Hash + Eq + ?Sized,

Attempt to retrieve a cached value with mutable access

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

Get or insert a key, value pair

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

Insert a key, value pair and return the previous value

fn cache_remove<Q>(&mut self, k: &Q) -> Option<V>where K: Borrow<Q>, Q: Hash + Eq + ?Sized,

Remove a cached value

fn cache_clear(&mut self)

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

fn cache_reset_metrics(&mut self)

Reset misses/hits counters

fn cache_reset(&mut self)

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

fn cache_size(&self) -> usize

Return the current cache size (number of elements)

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

Return the number of times a cached value was successfully retrieved

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

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

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

Return the lifespan of cached values (time to eviction)

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

Set the lifespan of cached values, returns the old value

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

Return the cache capacity

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

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

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

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.