Struct ClockProCache

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

A CLOCK-Pro cache that maps keys to values.

Implementations

impl<K, V> ClockProCache<K, V>

where K: Eq + Hash + Clone,

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

Create a new cache with the given capacity.

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

Create a new cache with the given value and test capacities.

The test capacity is used for tracking recently evicted entries, so that they will be considered frequently used if they get reinserted.

pub fn len(&self) -> usize

Returns the number of cached values.

pub fn is_empty(&self) -> bool

Returns true when no values are currently cached.

pub fn recent_len(&self) -> usize

Returns the number of recently inserted values.

pub fn frequent_len(&self) -> usize

Returns the number of frequently fetched or updated values.

pub fn test_len(&self) -> usize

Returns the number of test entries.

pub fn inserted(&self) -> u64

Returns how many values have been inserted into the cache overall.

pub fn evicted(&self) -> u64

Returns how many values have been evicted from the cache.

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

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

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 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 contains_key<Q>(&mut self, key: &Q) -> bool

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

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

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, V> Send for ClockProCache<K, V>

where K: Send, V: Send,

impl<K, V> Sync for ClockProCache<K, V>

where K: Sync, V: Sync,