Struct Cache 

pub struct Cache<K, V>
where
    K: Ord + Clone,
{ /* private fields */ }

Cache System

Description

A cache of values with a max size to ensure that too much old data is not stored.

Uses the CacheDeleteFunction type

Usage

extern crate alloc;
use gistools::data_structures::Cache;
use alloc::borrow::ToOwned;
use alloc::string::{String, ToString};

fn on_delete(key: &String, value: &String) {
    println!("Deleted key {} with value {}", key, value);
}

let mut cache = Cache::new(10, Some(on_delete));
cache.set("key".to_owned(), "value".to_owned());
println!("{:?}", cache.get(&"key".to_string())); // Some("value")
cache.delete(&"key".to_string());

Implementations

impl<K, V> Cache<K, V>

where K: Ord + Clone,

pub fn new( max_size: usize, on_delete: Option<CacheDeleteFunction<K, V>>, ) -> Self

Creates a new cache with a given max size and an optional deletion callback.

pub fn len(&self) -> usize

Returns the number of elements in the cache.

pub fn is_empty(&self) -> bool

Returns true if the cache is empty.

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

Inserts a key-value pair into the cache.

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

Retrieves a value from the cache.

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

Retrieves a mutable value from the cache.

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

Removes a key from the cache.

Trait Implementations

impl<K, V: Clone> Clone for Cache<K, V>

where K: Ord + Clone + Clone,

fn clone(&self) -> Cache<K, V>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<K, V: Debug> Debug for Cache<K, V>

where K: Ord + Clone + Debug,

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

Formats the value using the given formatter.

impl<K, V: Default> Default for Cache<K, V>

where K: Ord + Clone + Default,

fn default() -> Cache<K, V>

Returns the “default value” for a type.