Struct LruCache 

pub struct LruCache<K, V, S = RandomState> { /* private fields */ }

A weighted, thread-safe LRU cache.

Implementations

impl<K, V, S> LruCache<K, V, S>

pub const DEFAULT_SHARDS: usize = 1

Default shard count reported by LruCache::shard_count.

impl<K, V> LruCache<K, V, RandomState>

where K: Ord + Clone + Debug, V: CacheEntry + Clone,

pub fn new(max_cost: usize) -> Self

Creates a cache with the default hash builder.

impl<K, V, S> LruCache<K, V, S>

where K: Ord + Clone + Debug, V: CacheEntry + Clone,

pub fn with_hasher(max_cost: usize, _hash_builder: S) -> Self

Creates a cache with an explicit hash builder.

pub fn insert(&self, key: K, value: V)

Inserts or replaces key with value.

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

Looks up key and returns a clone of the stored value.

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

Removes key if present and returns the removed value.

pub fn remove_if<F>(&self, predicate: F)

where F: Fn(&K) -> bool,

Removes every entry whose key matches predicate.

pub fn remove_range<R>(&self, range: R) -> usize

where R: RangeBounds<K>,

Removes every entry whose key falls within range.

pub fn contains_key(&self, key: &K) -> bool

Returns true if key is currently resident.

pub fn len(&self) -> usize

Returns the number of resident entries.

pub fn total_charge(&self) -> usize

Returns the total resident cost.

pub fn total_capacity(&self) -> usize

Returns the configured total cost capacity.

pub fn shard_count(&self) -> usize

Returns the number of shards reported by this backend.

Trait Implementations

impl<K, V, S> BufferCache<K, V> for LruCache<K, V, S>

where K: Ord + Clone + Debug + Send + Sync + 'static, V: CacheEntry + Clone + Send + Sync + 'static, S: Send + Sync + 'static,

fn as_any(&self) -> &dyn Any

Returns this backend as Any for backend-specific downcasts.

fn strategy(&self) -> BufferCacheStrategy

Returns the eviction strategy used by this cache.

fn insert(&self, key: K, value: V)

Inserts or replaces key with value.

fn get(&self, key: K) -> Option<V>

Looks up key and returns a clone of the stored value.

fn remove(&self, key: &K) -> Option<V>

Removes key if it is present and returns the removed value.

fn remove_if(&self, predicate: &dyn Fn(&K) -> bool)

Removes every entry whose key matches predicate.

fn contains_key(&self, key: &K) -> bool

Returns true if key is currently resident.

fn len(&self) -> usize

Returns the number of resident entries.

fn total_charge(&self) -> usize

Returns the total resident weight.

fn total_capacity(&self) -> usize

Returns the configured total weight capacity.

fn shard_count(&self) -> usize

Returns the number of shards used by this backend.

fn is_empty(&self) -> bool

Returns true if the cache has no resident entries.