diff --git a/crates/mytheclipse-cache/src/lib.rs b/crates/mytheclipse-cache/src/lib.rs index 2a396d4..76df1e2 100644 --- a/crates/mytheclipse-cache/src/lib.rs +++ b/crates/mytheclipse-cache/src/lib.rs @@ -17,9 +17,12 @@ //! //! ## Example //! +//! Multi-layer + cache-aside composition (default features): +//! //! ```no_run -//! use mytheclipse_cache::{Cache, MemoryCache, MultiLayerCache, CacheAside}; +//! # #[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); @@ -34,6 +37,8 @@ //! ); //! let _v = aside.get("orders:42").await.unwrap(); //! # } +//! # #[cfg(not(all(feature = "l1-memory", feature = "cache-aside")))] +//! # fn run() {} //! ``` #![forbid(unsafe_code)] diff --git a/crates/mytheclipse-storage/src/lib.rs b/crates/mytheclipse-storage/src/lib.rs index 717aeb0..df35f42 100644 --- a/crates/mytheclipse-storage/src/lib.rs +++ b/crates/mytheclipse-storage/src/lib.rs @@ -15,15 +15,22 @@ //! //! ## Example //! -//! ``` -//! use mytheclipse_storage::{LocalFileStorage, StorageDriver, bytes_stream, read_to_vec}; -//! # #[tokio::main] async fn main() { +//! Local disk storage (`local` feature, default): +//! +//! ```no_run +//! use mytheclipse_storage::{StorageDriver, bytes_stream, read_to_vec}; +//! # #[cfg(feature = "local")] +//! # #[tokio::main] +//! # async fn main() { +//! use mytheclipse_storage::LocalFileStorage; //! # let dir = tempfile::tempdir().unwrap(); //! let storage = LocalFileStorage::new(dir.path()); //! storage.put("hello.txt", bytes_stream(b"hi".to_vec())).await.unwrap(); //! let data = read_to_vec(storage.get("hello.txt").await.unwrap()).await.unwrap(); //! assert_eq!(data, b"hi"); //! # } +//! # #[cfg(not(feature = "local"))] +//! # fn main() {} //! ``` pub mod traits;