mytheclipse-cache 1.8.0

Unified multi-layer cache abstraction: L1/L2 caching, cache-aside and auto-refresh, with pluggable backends.
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

//! # mytheclipse-cache
//!
//! A unified multi-layer cache abstraction that keeps your application from
//! being locked to any single cache provider.
//!
//! - **L1 (in-process) caches**: [`memory::MemoryCache`] (zero-dependency,
//!   default) or [`moka_cache::MokaL1`] (high-performance, TTL/max-capacity).
//! - **L2 (distributed) caches**: [`redis::RedisCache`] backed by Redis/Valkey.
//! - **Multi-layer composition**: [`multilayer::MultiLayerCache`] layers an L1
//!   over an L2 behind one [`Cache`] face; reads fall through to L2 and
//!   backfill L1.
//! - **Cache-aside / auto-refresh**: [`cache_aside::CacheAside`] reads through
//!   to a data source on a miss and caches the result.
//!
//! The core [`Cache`] trait is byte-oriented; typed convenience (JSON) is
//! layered on top via [`memory::typed::TypedCache`].
//!
//! ## Example
//!
//! Multi-layer + cache-aside composition (default features):
//!
//! ```no_run
//! # #[cfg(all(feature = "l1-memory", feature = "cache-aside"))]
//! # async fn run() {
//! use mytheclipse_cache::{Cache, MemoryCache, MultiLayerCache, CacheAside};
//! let l1 = MemoryCache::new();
//! let l2 = MemoryCache::new(); // in a real app: a RedisCache
//! let cache = MultiLayerCache::new(l1, l2);
//!
//! cache.set("user:1", b"payload".to_vec(), None).await.unwrap();
//! assert_eq!(cache.get("user:1").await.unwrap(), Some(b"payload".to_vec()));
//!
//! // Cache-aside: fill misses from a source of truth.
//! let aside = CacheAside::new(
//!     MemoryCache::new(),
//!     |key| async move { Some(format!("data-for-{key}").into_bytes()) },
//! );
//! let _v = aside.get("orders:42").await.unwrap();
//! # }
//! # #[cfg(not(all(feature = "l1-memory", feature = "cache-aside")))]
//! # fn run() {}
//! ```

#![forbid(unsafe_code)]

pub mod traits;

#[cfg(feature = "l1-memory")]
pub mod memory;

#[cfg(feature = "l1-moka")]
pub mod moka_cache;

#[cfg(feature = "l2-redis")]
pub mod redis;

#[cfg(feature = "cache-aside")]
pub mod cache_aside;

#[cfg(feature = "cache-aside")]
pub mod multilayer;

#[cfg(feature = "cache-aside")]
pub mod auto_refresh;

#[cfg(feature = "cache-aside")]
pub mod metrics;

pub use traits::{Cache, CacheError};

#[cfg(feature = "l1-memory")]
pub use memory::MemoryCache;

#[cfg(feature = "l1-moka")]
pub use moka_cache::MokaL1;

#[cfg(feature = "l2-redis")]
pub use redis::RedisCache;

#[cfg(feature = "cache-aside")]
pub use cache_aside::CacheAside;

#[cfg(feature = "cache-aside")]
pub use multilayer::MultiLayerCache;