Struct TaggableCache 

pub struct TaggableCache { /* private fields */ }

Main cache facade.

Implementations

impl Cache

pub fn new(store: Arc<dyn CacheStore>) -> Cache

Create a new cache with the given store.

pub fn with_config(store: Arc<dyn CacheStore>, config: CacheConfig) -> Cache

Create a cache with configuration.

pub fn memory() -> Cache

Create an in-memory cache.

pub async fn from_env() -> Result<Cache, Error>

Create a cache from environment variables.

Reads the following environment variables:

• CACHE_DRIVER: Cache driver (“memory” or “redis”, default: “memory”)
• CACHE_PREFIX: Key prefix for all cache entries (default: “”)
• CACHE_TTL: Default TTL in seconds (default: 3600)
• CACHE_MEMORY_CAPACITY: Max entries for memory store (default: 10000)
• REDIS_URL: Redis connection URL (required if CACHE_DRIVER=redis)

Example

use ferro_cache::Cache;

let cache = Cache::from_env().await?;

pub async fn get<T>(&self, key: &str) -> Result<Option<T>, Error>

where T: DeserializeOwned,

Get a value from the cache.

pub async fn put<T>( &self, key: &str, value: &T, ttl: Duration, ) -> Result<(), Error>

where T: Serialize,

Put a value in the cache.

pub async fn put_default<T>(&self, key: &str, value: &T) -> Result<(), Error>

where T: Serialize,

Put a value using the default TTL.

pub async fn forever<T>(&self, key: &str, value: &T) -> Result<(), Error>

where T: Serialize,

Store a value forever (very long TTL).

pub async fn has(&self, key: &str) -> Result<bool, Error>

Check if a key exists.

pub async fn forget(&self, key: &str) -> Result<bool, Error>

Remove a key from the cache.

pub async fn flush(&self) -> Result<(), Error>

Remove all items from the cache.

pub async fn remember<T, F, Fut>( &self, key: &str, ttl: Duration, f: F, ) -> Result<T, Error>

where T: Serialize + DeserializeOwned, F: FnOnce() -> Fut, Fut: Future<Output = T>,

Get a value or compute it if not cached.

pub async fn remember_forever<T, F, Fut>( &self, key: &str, f: F, ) -> Result<T, Error>

where T: Serialize + DeserializeOwned, F: FnOnce() -> Fut, Fut: Future<Output = T>,

Get a value or compute it, caching forever.

pub async fn pull<T>(&self, key: &str) -> Result<Option<T>, Error>

where T: DeserializeOwned,

Pull a value from cache and remove it.

pub async fn increment(&self, key: &str, value: i64) -> Result<i64, Error>

Increment a numeric value.

pub async fn decrement(&self, key: &str, value: i64) -> Result<i64, Error>

Decrement a numeric value.

pub fn tags(&self, tags: &[&str]) -> TaggedCache

Create a tagged cache instance.

Trait Implementations

impl Clone for Cache

fn clone(&self) -> Cache

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.