Struct weight_cache::WeightCache

pub struct WeightCache<K, V, S = RandomState> { /* fields omitted */ }

A cache that holds a limited number of key-value pairs. When the capacity of the cache is exceeded, the least-recently-used (where “used” means a look-up or putting the pair into the cache) pairs are automatically removed until the size limit is met again.

Implementations

impl<K: Hash + Eq, V: Weighable> WeightCache<K, V>

pub fn new(capacity: NonZeroUsize) -> Self

impl<K: Hash + Eq, V: Weighable, S: BuildHasher> WeightCache<K, V, S>

pub fn with_hasher(capacity: NonZeroUsize, hasher: S) -> Self

Create a WeightCache with a custom hasher.

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

Returns a reference to the value corresponding to the given key, if it exists.

pub fn len(&self) -> usize

Returns the number of key-value pairs in the cache.

pub fn is_empty(&self) -> bool

Returns true if the cache contains no key-value pairs.

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

Inserts a key-value pair into the cache. Returns an error if the value is bigger than the cache’s configured max size.

impl<K: Hash + Eq + 'static, V: Weighable + 'static, S: BuildHasher> WeightCache<K, V, S>

pub fn consume(self) -> Box<dyn Iterator<Item = (K, V)> + 'static>

Returns an iterator over the cache’s key-value pairs in least- to most-recently-used order consuming the cache.

Trait Implementations

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

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

Formats the value using the given formatter.

impl<K: Hash + Eq, V: Weighable> Default for WeightCache<K, V>

fn default() -> Self

Returns the “default value” for a type.