Struct memory_lru::MemoryLruCache

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

An LRU-cache which operates on memory used.

Implementations

impl<K: Eq + Hash, V: ResidentSize> MemoryLruCache<K, V>

pub fn new(max_size: usize) -> Self

Create a new cache with a maximum cumulative size of values.

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

Insert an item.

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

Get a reference to an item in the cache. It is a logic error for its heap size to be altered while borrowed.

pub fn with_mut<U>(
    &mut self,
    key: &K,
    with: impl FnOnce(Option<&mut V>) -> U
) -> U

Execute a closure with the value under the provided key.

pub fn current_size(&self) -> usize

Currently-used size of values in bytes.

pub fn len(&self) -> usize

Returns the number of key-value pairs that are currently in the cache.

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

Returns a bool indicating whether the given key is in the cache. Does not update the LRU list.

pub fn is_empty(&self) -> bool

Returns a bool indicating whether the cache is empty or not.

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

Returns a reference to the value corresponding to the key in the cache or None if it is not present in the cache. Unlike get, peek does not update the LRU list so the key’s position will be unchanged.