Struct memo_cache::MemoCache

pub struct MemoCache<K, V, const SIZE: usize> { /* private fields */ }

A small, fixed-size, heap-allocated key/value cache with retention management.

Implementations

impl<K, V, const SIZE: usize> MemoCache<K, V, SIZE>

where K: Clone + Eq, V: Clone,

pub fn new() -> Self

Create a new cache.

Examples

use memo_cache::MemoCache;

let c = MemoCache::<u32, String, 4>::new();

pub const fn capacity(&self) -> usize

Get the (fixed) capacity of the cache.

Examples

use memo_cache::MemoCache;

let c = MemoCache::<u32, String, 8>::new();

assert_eq!(c.capacity(), 8);

pub fn insert(&mut self, k: K, v: V)

Insert a key/value pair.

Examples

use memo_cache::MemoCache;

let mut c = MemoCache::<u32, &str, 4>::new();

assert_eq!(c.get(&42), None);

c.insert(42, "The Answer");

assert_eq!(c.get(&42), Some(&"The Answer"));

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

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

Lookup a cache entry by key.

Examples

use memo_cache::MemoCache;

let mut c = MemoCache::<u32, &str, 4>::new();

assert_eq!(c.get(&42), None);

c.insert(42, "The Answer");

assert_eq!(c.get(&42), Some(&"The Answer"));

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

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

Lookup a cache entry by key (for mutation).

Examples

use memo_cache::MemoCache;

let mut c = MemoCache::<u32, &str, 4>::new();

c.insert(42, "The Answer");

if let Some(v) = c.get_mut(&42) {
    *v = "Another Answer";
}

assert_eq!(c.get(&42), Some(&"Another Answer"));

pub fn clear(&mut self)

Clear the cache.

Examples

use memo_cache::MemoCache;

let mut c = MemoCache::<u32, &str, 4>::new();

assert_eq!(c.get(&42), None);

c.insert(42, "The Answer");

assert_eq!(c.get(&42), Some(&"The Answer"));

c.clear();

assert_eq!(c.get(&42), None);

Trait Implementations

impl<K, V, const SIZE: usize> Default for MemoCache<K, V, SIZE>

where K: Clone + Eq, V: Clone,

fn default() -> Self

Returns the “default value” for a type.