Struct generational_lru::lrucache::LRUCache

pub struct LRUCache<K, V> where
    K: Eq + Hash,  {
    blocks: LinkedList<Block<K, V>>,
    block_refs: HashMap<K, Link>,
}

A Least-Recently-Used (LRU) Cache implemented using a generational arena based linked list and a hash map.

Fields

blocks: LinkedList<Block<K, V>>

block_refs: HashMap<K, Link>

Implementations

impl<K, V> LRUCache<K, V> where
    K: Eq + Hash + Copy, 

pub fn with_capacity(capacity: usize) -> Self

Creates an LRUCache instance with the given capacity. A zero capacity LRUCache is unusable.

pub fn query(&mut self, key: &K) -> Result<&V, CacheError>

Returns a reference to the value associated with the given key. If the key is not present in the cache, we return a “cache-miss” error. If the entry is found but cannot be fetched from the underlying storage, we return a “cache-broken” error.

pub fn remove(&mut self, key: &K) -> Result<V, CacheError>

Removes the associated key value pair for the given key from this cache. If no entry is found, we return a “cache-miss” error. If the entry is found but cannot be fetched from the underlying in-memory storage, we return a “cache-broken” error. Returns the value associated, after removal with ownership.

pub fn insert(&mut self, key: K, value: V) -> Result<(), CacheError>

Inserts a new key value pair into this cache. If this cache is full, the least recently used entry is removed.