Struct SieveCache

pub struct SieveCache<K: Eq + Hash + Clone, V> { /* private fields */ }

A cache based on the SIEVE eviction algorithm.

Implementations

impl<K: Eq + Hash + Clone, V> SieveCache<K, V>

pub fn new(capacity: usize) -> Result<Self, &'static str>

Create a new cache with the given capacity.

pub fn capacity(&self) -> usize

Return the capacity of the cache.

pub fn len(&self) -> usize

Return the number of cached values.

pub fn is_empty(&self) -> bool

Return true when no values are currently cached.

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

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

Return true if there is a value in the cache mapped to by key.

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

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

Get an immutable reference to the value in the cache mapped to by key.

If no value exists for key, this returns None.

pub fn get_mut<Q>(&mut self, key: &Q) -> Option<&mut V>

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

Get a mutable reference to the value in the cache mapped to by key.

If no value exists for key, this returns None.

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

Map key to value in the cache, possibly evicting old entries.

This method returns true when this is a new entry, and false if an existing entry was updated.

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

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

Remove the cache entry mapped to by key.

This method returns the value removed from the cache. If key did not map to any value, then this returns None.

Trait Implementations

impl<K: Eq + Hash + Clone, V> Send for SieveCache<K, V>