asepharyana
db4f277336
- Introduced corex-storage crate with support for local disk, S3-compatible, and Google Cloud Storage backends. - Implemented StorageDriver trait for various storage backends. - Added LocalFileStorage for local disk operations. - Added S3Storage for S3-compatible object storage with multipart upload support. - Added GcsStorage for Google Cloud Storage operations. - Included error handling for storage operations. - Added tests for each storage backend to ensure functionality. - Created README.md for documentation and usage examples. - Added Apache and MIT licenses for open-source compliance.
74 lines
2.1 KiB
Rust
74 lines
2.1 KiB
Rust
//! # corex-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
|
|
//!
|
|
//! ```no_run
|
|
//! use corex_cache::{Cache, MemoryCache, MultiLayerCache, CacheAside};
|
|
//! # async fn run() {
|
|
//! 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();
|
|
//! # }
|
|
//! ```
|
|
|
|
#![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;
|
|
|
|
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;
|