Struct MemoryCache

pub struct MemoryCache<K: Hash, T: Clone> { /* private fields */ }

A high performant in-memory cache with S3-FIFO + TinyLFU

Implementations

impl<K: Hash, T: Clone + Send + Sync + 'static> MemoryCache<K, T>

pub fn new(size: usize) -> Self

Create a new MemoryCache with the given size.

pub fn get<Q>(&self, key: &Q) -> (Option<T>, CacheStatus)

where K: Borrow<Q>, Q: Hash + ?Sized,

Fetch the key and return its value in addition to a CacheStatus.

pub fn get_stale<Q>(&self, key: &Q) -> (Option<T>, CacheStatus)

where K: Borrow<Q>, Q: Hash + ?Sized,

Similar to Self::get, fetch the key and return its value in addition to a CacheStatus but also return the value even if it is expired. When the value is expired, the Duration of how long it has been stale will also be returned.

pub fn put<Q>(&self, key: &Q, value: T, ttl: Option<Duration>)

where K: Borrow<Q>, Q: Hash + ?Sized,

Insert a key and value pair with an optional TTL into the cache.

An item with zero TTL of zero will not be inserted.

pub fn remove<Q>(&self, key: &Q)

where K: Borrow<Q>, Q: Hash + ?Sized,

Remove a key from the cache if it exists.

pub fn multi_get<'a, I, Q>(&self, keys: I) -> Vec<(Option<T>, CacheStatus)>

where I: Iterator<Item = &'a Q>, Q: Hash + ?Sized + 'a, K: Borrow<Q> + 'a,

This is equivalent to MemoryCache::get but for an arbitrary amount of keys.

pub fn multi_get_with_miss<'a, I, Q>( &self, keys: I, ) -> (Vec<(Option<T>, CacheStatus)>, Vec<&'a Q>)

where I: Iterator<Item = &'a Q>, Q: Hash + ?Sized + 'a, K: Borrow<Q> + 'a,

Same as MemoryCache::multi_get but returns the keys that are missing from the cache.