cachet 0.3.0

A composable, customizable multi-tier caching library with rich feature support.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84

// Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.

//! Time-to-refresh: return stale data immediately, refresh in background.
//! Keeps cache warm and avoids latency spikes from cache misses.

use std::sync::Arc;
use std::sync::atomic::{AtomicU32, Ordering};
use std::time::Duration;

use anyspawn::Spawner;
use cachet::{Cache, CacheEntry, CacheTier, Error, TimeToRefresh};
use tick::Clock;

#[derive(Clone)]
struct Database {
    calls: Arc<AtomicU32>,
    clock: Clock,
}

impl CacheTier<String, String> for Database {
    async fn get(&self, key: &String) -> Result<Option<CacheEntry<String>>, Error> {
        let v = self.calls.fetch_add(1, Ordering::Relaxed) + 1;
        self.clock.delay(Duration::from_millis(50)).await;
        Ok(Some(CacheEntry::new(format!("{key}_v{v}"))))
    }

    async fn insert(&self, _: String, _: CacheEntry<String>) -> Result<(), Error> {
        Ok(())
    }

    async fn invalidate(&self, _: &String) -> Result<(), Error> {
        Ok(())
    }

    async fn clear(&self) -> Result<(), Error> {
        Ok(())
    }
}

#[tokio::main]
async fn main() {
    let clock = Clock::new_tokio();
    let db = Database {
        calls: Arc::new(AtomicU32::new(0)),
        clock: clock.clone(),
    };

    let cache = Cache::builder::<String, String>(clock.clone())
        .memory()
        .ttl(Duration::from_secs(10))
        .fallback(Cache::builder::<String, String>(clock.clone()).storage(db.clone()))
        .time_to_refresh(TimeToRefresh::new(Duration::from_secs(1), Spawner::new_tokio()))
        .build();

    let key = "config".to_string();

    // Initial fetch (db call #1)
    let v = cache.get(&key).await.expect("get failed");
    match v {
        Some(e) => println!("initial: {} (db calls: {})", e.value(), db.calls.load(Ordering::Relaxed)),
        None => println!("initial: not found (db calls: {})", db.calls.load(Ordering::Relaxed)),
    }

    // Wait past refresh threshold
    clock.delay(Duration::from_millis(1500)).await;

    // Returns stale value immediately, triggers background refresh
    let v = cache.get(&key).await.expect("get failed");
    match v {
        Some(e) => println!("stale: {}", e.value()),
        None => println!("stale: not found"),
    }

    // Wait for refresh to complete
    clock.delay(Duration::from_millis(100)).await;

    // Now returns refreshed value
    let v = cache.get(&key).await.expect("get failed");
    match v {
        Some(e) => println!("refreshed: {} (db calls: {})", e.value(), db.calls.load(Ordering::Relaxed)),
        None => println!("refreshed: not found (db calls: {})", db.calls.load(Ordering::Relaxed)),
    }
}