Struct r_cache::cache::Cache

pub struct Cache<T, V> { /* fields omitted */ }

Implementations

impl<T, V> Cache<T, V>

pub fn new(item_duration: Option<Duration>) -> Self

Construct a new Cache with a default item expiration time. An item duration of None means items do not expire by default.

Example

use async_std::sync::Arc;
use async_std::task;
use r_cache::cache::Cache;
use std::time::Duration;

const KEY: i8 = 0;
const VALUE: &str = "VALUE";

#[async_std::main]
async fn main() {
    let cache = Arc::new(Cache::new(Some(Duration::from_secs(5 * 60))));
    task::spawn({
        let cache = Arc::clone(&cache);
        async move {
            loop {
                task::sleep(Duration::from_secs(10 * 60)).await;
                cache.remove_expired().await;
            }
        }
    });

    cache.set(KEY, VALUE, None).await;

    assert_eq!(VALUE, cache.get(&KEY).await.unwrap())
}

pub async fn get(&self, key: &T) -> Option<V> where
    T: Eq + Hash,
    V: Clone, 

Get a cache item associated with a given key.

pub async fn set(
    &self,
    key: T,
    value: V,
    custom_duration: Option<Duration>
) -> Option<V> where
    T: Eq + Hash, 

Set an item in the cache with an associated key. The item will have the default cache expiration time if custom duration of None is given.

pub async fn remove_expired(&self) where
    T: Eq + Hash + Clone, 

Remove all expired items from the cache.

pub async fn remove(&self, key: &T) -> Option<V> where
    T: Eq + Hash, 

Remove an item from the cache associated with a given key.

pub async fn clear(&self)

Clear the entire cache of all items regardless of expiry times.