Skip to main content

LfuCache

Struct LfuCache 

Source
pub struct LfuCache<K, V> { /* private fields */ }
Expand description

An LFU cache with a fixed capacity and optional per-entry TTL.

Entries with equal frequency are evicted in FIFO order (the entry inserted earlier at that frequency is evicted first).

§Type parameters

  • K: key type — must be Eq + Hash + Clone.
  • V: value type.

Implementations§

Source§

impl<K, V> LfuCache<K, V>
where K: Eq + Hash + Clone,

Source

pub fn new(cap: usize) -> Self

Create a new LfuCache with the given capacity.

A capacity of 0 is valid; every insert will immediately be evicted on the next insert.

Source

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

Return the value for key, incrementing its frequency.

If the entry has expired (TTL), it is removed and None is returned without updating frequency or recency.

Source

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

Insert or update key -> value (no TTL).

Source

pub fn put_with_ttl(&mut self, key: K, value: V, ttl: Duration) -> Option<V>

Insert or update key -> value with a TTL.

Source

pub fn len(&self) -> usize

Number of entries currently in the cache.

Source

pub fn is_empty(&self) -> bool

Return true if the cache is empty.

Source

pub fn cap(&self) -> usize

Cache capacity.

Source

pub fn peek(&self, key: &K) -> Option<&V>

Read a value without updating frequency or recency.

Returns None if absent or expired.

Source

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

Return true if key is present and not expired.

Source

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

Remove the entry for key, returning its value.

Source

pub fn clear(&mut self)

Remove all entries.

Source

pub fn resize(&mut self, new_cap: usize)

Dynamically resize the cache capacity.

If new_cap < current len, entries at min_freq are evicted first (FIFO within that frequency), then the next lowest frequency, etc.

Trait Implementations§

Source§

impl<K, V> Cache<K, V> for LfuCache<K, V>
where K: Eq + Hash + Clone,

Source§

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

Look up key, returning a reference to the value if present. Read more
Source§

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

Insert or update key -> value without a TTL. Read more
Source§

fn put_with_ttl(&mut self, key: K, value: V, ttl: Duration) -> Option<V>

Insert or update key -> value with a time-to-live. Read more
Source§

fn len(&self) -> usize

Return the number of live entries currently in the cache.
Source§

fn cap(&self) -> usize

Return the maximum number of entries the cache can hold.
Source§

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

Remove the entry associated with key, returning its value if present. Read more
Source§

fn clear(&mut self)

Remove all entries from the cache.
Source§

fn peek(&self, key: &K) -> Option<&V>

Look up key without updating access metadata (no promotion). Read more
Source§

fn contains_key(&self, key: &K) -> bool

Return true if key is present in the cache (without promotion). Read more
Source§

fn resize(&mut self, new_cap: usize)

Dynamically resize the cache capacity. Read more
Source§

fn is_empty(&self) -> bool

Return true if the cache holds no entries.
Source§

fn get_or_insert(&mut self, key: K, default: impl FnOnce() -> V) -> &V
where K: Clone,

Return &V for key, inserting default() if the key is absent. Read more
Source§

fn values(&self) -> Vec<&V>

Return all live (non-expired) values currently stored in the cache. Read more
Source§

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

Pre-populate the cache with (key, value) pairs from an iterator. Read more

Auto Trait Implementations§

§

impl<K, V> Freeze for LfuCache<K, V>

§

impl<K, V> RefUnwindSafe for LfuCache<K, V>

§

impl<K, V> Send for LfuCache<K, V>
where K: Send, V: Send,

§

impl<K, V> Sync for LfuCache<K, V>
where K: Sync, V: Sync,

§

impl<K, V> Unpin for LfuCache<K, V>
where K: Unpin, V: Unpin,

§

impl<K, V> UnsafeUnpin for LfuCache<K, V>

§

impl<K, V> UnwindSafe for LfuCache<K, V>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.