LruMap

Struct LruMap 

Source
pub struct LruMap<K: PartialEq, V, const S: usize> { /* private fields */ }
Expand description

The LruMap (i.e. Least Recently Used Map) is a map of keys to values, with a fixed capacity. Adding keys beyond the capacity will remove the least recently accessed key-value tuple and return it.

Implementations§

Source§

impl<K: PartialEq, V, const S: usize> LruMap<K, V, S>

Source

pub const fn new() -> Self

Create a new LruMap

Source

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

Insert a new entry to the cache, and evict the least recently used one if capacity has been reached

Source

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

Get the value by key if it exists

If you need a mutable reference, you can use “as_mut”

Source

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

Returns None if there is still more capacity, or if there is no LRU.

Source

pub fn capacity(&self) -> usize

Returns the capacity of the map

Source

pub fn len(&self) -> usize

Returns the len of the map. Can be used to determine if you should use insert or get_least_recently_used

Auto Trait Implementations§

§

impl<K, V, const S: usize> Freeze for LruMap<K, V, S>
where K: Freeze, V: Freeze,

§

impl<K, V, const S: usize> RefUnwindSafe for LruMap<K, V, S>

§

impl<K, V, const S: usize> Send for LruMap<K, V, S>
where K: Send, V: Send,

§

impl<K, V, const S: usize> Sync for LruMap<K, V, S>
where K: Sync, V: Sync,

§

impl<K, V, const S: usize> Unpin for LruMap<K, V, S>
where K: Unpin, V: Unpin,

§

impl<K, V, const S: usize> UnwindSafe for LruMap<K, V, S>
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, 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, 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.