Struct LruCache

pub struct LruCache<K, V, S = DefaultHashBuilder> { /* private fields */ }

Implementations

impl<K: Eq + Hash, V> LruCache<K, V>

pub fn new(capacity: usize) -> Self

pub fn new_unbounded() -> Self

Create a new unbounded LruCache that does not automatically evict entries.

A simple convenience method that is equivalent to LruCache::new(usize::MAX)

impl<K, V, S> LruCache<K, V, S>

pub fn with_hasher(capacity: usize, hash_builder: S) -> Self

pub fn capacity(&self) -> usize

pub fn len(&self) -> usize

pub fn is_empty(&self) -> bool

pub fn clear(&mut self)

pub fn iter(&self) -> Iter<'_, K, V>

pub fn iter_mut(&mut self) -> IterMut<'_, K, V>

pub fn drain(&mut self) -> Drain<'_, K, V>

impl<K: Eq + Hash, V, S> LruCache<K, V, S>

where S: BuildHasher,

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

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

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

Insert a new value into the LruCache.

If necessary, will remove the value at the front of the LRU list to make room.

pub fn peek<Q>(&self, k: &Q) -> Option<&V>

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

Get the value for the given key, without marking the value as recently used and moving it to the back of the LRU list.

pub fn peek_mut<Q>(&mut self, k: &Q) -> Option<&mut V>

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

Get the value for the given key mutably, without marking the value as recently used and moving it to the back of the LRU list.

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

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

Retrieve the given key, marking it as recently used and moving it to the back of the LRU list.

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

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

Retrieve the given key, marking it as recently used and moving it to the back of the LRU list.

pub fn entry(&mut self, key: K) -> Entry<'_, K, V, S>

If the returned entry is vacant, it will always have room to insert a single value. By using the entry API, you can exceed the configured capacity by 1.

The returned entry is not automatically moved to the back of the LRU list. By calling Entry::to_back / Entry::to_front you can manually control the position of this entry in the LRU list.

pub fn raw_entry(&self) -> RawEntryBuilder<'_, K, V, S>

The constructed raw entry is never automatically moved to the back of the LRU list. By calling Entry::to_back / Entry::to_front you can manually control the position of this entry in the LRU list.

pub fn raw_entry_mut(&mut self) -> RawEntryBuilderMut<'_, K, V, S>

If the constructed raw entry is vacant, it will always have room to insert a single value. By using the raw entry API, you can exceed the configured capacity by 1.

The constructed raw entry is never automatically moved to the back of the LRU list. By calling Entry::to_back / Entry::to_front you can manually control the position of this entry in the LRU list.

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

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

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

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

pub fn set_capacity(&mut self, capacity: usize)

Set the new cache capacity for the LruCache.

If there are more entries in the LruCache than the new capacity will allow, they are removed.

pub fn remove_lru(&mut self) -> Option<(K, V)>

Remove the least recently used entry and return it.

If the LruCache is empty this will return None.

Trait Implementations

impl<K: Hash + Eq + Clone, V: Clone, S: BuildHasher + Clone> Clone for LruCache<K, V, S>

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

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

where K: Debug, V: Debug,

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

Formats the value using the given formatter.

impl<K: Eq + Hash, V, S: BuildHasher> Extend<(K, V)> for LruCache<K, V, S>

fn extend<I: IntoIterator<Item = (K, V)>>(&mut self, iter: I)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl<'a, K, V, S> IntoIterator for &'a LruCache<K, V, S>

type Item = (&'a K, &'a V)

The type of the elements being iterated over.

type IntoIter = Iter<'a, K, V>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Iter<'a, K, V>

Creates an iterator from a value.

impl<'a, K, V, S> IntoIterator for &'a mut LruCache<K, V, S>

type Item = (&'a K, &'a mut V)

The type of the elements being iterated over.

type IntoIter = IterMut<'a, K, V>

Which kind of iterator are we turning this into?

fn into_iter(self) -> IterMut<'a, K, V>

Creates an iterator from a value.

impl<K, V, S> IntoIterator for LruCache<K, V, S>

type Item = (K, V)

The type of the elements being iterated over.

type IntoIter = IntoIter<K, V>

Which kind of iterator are we turning this into?

fn into_iter(self) -> IntoIter<K, V>

Creates an iterator from a value.