Skip to main content

LruCache

Struct LruCache 

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

A fixed-capacity, in-memory least-recently-used (LRU) cache.

When the cache is full, inserting a new entry evicts the entry that was least recently accessed. Updating an existing key moves it to the most-recently-used position without consuming extra capacity.

LruCache is not Sync; wrap it in std::sync::RwLock or std::sync::Mutex when sharing across threads.

§Type parameters

  • K — key type; must implement Eq, Hash, and Clone.
  • V — value type; no bounds required.

§Examples

use std::num::NonZeroUsize;
use modo::cache::LruCache;

let mut cache: LruCache<&str, u32> = LruCache::new(NonZeroUsize::new(2).unwrap());
cache.put("a", 1);
cache.put("b", 2);
assert_eq!(cache.get(&"a"), Some(&1));

// Inserting a third entry evicts "b" (least recently used).
cache.put("c", 3);
assert!(cache.get(&"b").is_none());

Implementations§

Source§

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

Source

pub fn new(capacity: NonZeroUsize) -> Self

Creates a new LruCache with the given maximum capacity.

The cache will hold at most capacity entries at any time. When a new entry is inserted into a full cache, the least-recently-used entry is evicted first.

Source

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

Returns a reference to the value associated with key, or None if the key is not present.

Accessing a key moves it to the most-recently-used position, making it the last candidate for eviction.

Source

pub fn put(&mut self, key: K, value: V)

Inserts or updates the entry for key with the given value.

  • If key already exists, its value is replaced and it moves to the most-recently-used position.
  • If the cache is at capacity and key is new, the least-recently-used entry is evicted before the new entry is inserted.

Auto Trait Implementations§

§

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

§

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

§

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

§

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

§

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

§

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

§

impl<K, V> UnwindSafe for LruCache<K, V>
where K: UnwindSafe, V: UnwindSafe,

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<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> Same for T

Source§

type Output = T

Should always be Self
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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<A, B, T> HttpServerConnExec<A, B> for T
where B: Body,