Enum Cache

pub enum Cache<K, V, S = RandomState>
where
    K: Key,
    V: Value,
    S: HashBuilder,
{
    Fifo(Arc<GenericCache<K, V, SanityEviction<Fifo<(K, V)>>, SanityIndexer<HashTableIndexer<K, FifoHandle<(K, V)>>>, S>>),
    Lru(Arc<GenericCache<K, V, SanityEviction<Lru<(K, V)>>, SanityIndexer<HashTableIndexer<K, LruHandle<(K, V)>>>, S>>),
    Lfu(Arc<GenericCache<K, V, SanityEviction<Lfu<(K, V)>>, SanityIndexer<HashTableIndexer<K, LfuHandle<(K, V)>>>, S>>),
    S3Fifo(Arc<GenericCache<K, V, SanityEviction<S3Fifo<(K, V)>>, SanityIndexer<HashTableIndexer<K, S3FifoHandle<(K, V)>>>, S>>),
}

In-memory cache with plug-and-play algorithms.

Variants

Fifo(Arc<GenericCache<K, V, SanityEviction<Fifo<(K, V)>>, SanityIndexer<HashTableIndexer<K, FifoHandle<(K, V)>>>, S>>)

In-memory FIFO cache.

Lru(Arc<GenericCache<K, V, SanityEviction<Lru<(K, V)>>, SanityIndexer<HashTableIndexer<K, LruHandle<(K, V)>>>, S>>)

In-memory LRU cache.

Lfu(Arc<GenericCache<K, V, SanityEviction<Lfu<(K, V)>>, SanityIndexer<HashTableIndexer<K, LfuHandle<(K, V)>>>, S>>)

In-memory LFU cache.

S3Fifo(Arc<GenericCache<K, V, SanityEviction<S3Fifo<(K, V)>>, SanityIndexer<HashTableIndexer<K, S3FifoHandle<(K, V)>>>, S>>)

In-memory S3FIFO cache.

Implementations

impl<K, V, S> Cache<K, V, S>

where K: Key, V: Value, S: HashBuilder,

pub fn insert(&self, key: K, value: V) -> CacheEntry<K, V, S>

Insert cache entry to the in-memory cache.

pub fn insert_with_context( &self, key: K, value: V, context: CacheContext, ) -> CacheEntry<K, V, S>

Insert cache entry with cache context to the in-memory cache.

pub fn deposit(&self, key: K, value: V) -> CacheEntry<K, V, S>

Temporarily insert cache entry to the in-memory cache.

The entry will be removed as soon as the returned entry is dropped.

The entry will become a normal entry after it is accessed.

pub fn deposit_with_context( &self, key: K, value: V, context: CacheContext, ) -> CacheEntry<K, V, S>

Temporarily insert cache entry with cache context to the in-memory cache.

The entry will be removed as soon as the returned entry is dropped.

The entry will become a normal entry after it is accessed.

pub fn remove<Q>(&self, key: &Q) -> Option<CacheEntry<K, V, S>>

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

Remove a cached entry with the given key from the in-memory cache.

pub fn get<Q>(&self, key: &Q) -> Option<CacheEntry<K, V, S>>

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

Get cached entry with the given key from the in-memory cache.

pub fn contains<Q>(&self, key: &Q) -> bool

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

Check if the in-memory cache contains a cached entry with the given key.

pub fn touch<Q>(&self, key: &Q) -> bool

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

Access the cached entry with the given key but don’t return.

Note: This method can be used to update the cache eviction information and order based on the algorithm.

pub fn clear(&self)

Clear the in-memory cache.

pub fn capacity(&self) -> usize

Get the capacity of the in-memory cache.

pub fn usage(&self) -> usize

Get the usage of the in-memory cache.

pub fn hash<Q>(&self, key: &Q) -> u64

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

Hash the given key with the hash builder of the cache.

impl<K, V, S> Cache<K, V, S>

where K: Key + Clone, V: Value, S: HashBuilder,

pub fn fetch<F, FU, ER>(&self, key: K, fetch: F) -> Fetch<K, V, ER, S>

where F: FnOnce() -> FU, FU: Future<Output = Result<V, ER>> + Send + 'static, ER: Send + 'static + Debug,

Get the cached entry with the given key from the in-memory cache.

Use fetch to fetch the cache value from the remote storage on cache miss.

The concurrent fetch requests will be deduplicated.

pub fn fetch_with_context<F, FU, ER>( &self, key: K, context: CacheContext, fetch: F, ) -> Fetch<K, V, ER, S>

where F: FnOnce() -> FU, FU: Future<Output = Result<V, ER>> + Send + 'static, ER: Send + 'static + Debug,

Get the cached entry with the given key and context from the in-memory cache.

Use fetch to fetch the cache value from the remote storage on cache miss.

The concurrent fetch requests will be deduplicated.

Trait Implementations

impl<K, V, S> Clone for Cache<K, V, S>

where K: Key, V: Value, S: HashBuilder,

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<K, V, S> Debug for Cache<K, V, S>

where K: Key, V: Value, S: HashBuilder,

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

Formats the value using the given formatter.