Struct Cache 

pub struct Cache { /* private fields */ }

A cheap-to-clone handle over a CacheStore, with a typed, ergonomic API.

Values are serialized to JSON before being stored and deserialized on the way out, so any serde type can be cached. Cloning a Cache is cheap (it shares the underlying store), so it is held as an injected resource.

Examples

cache.set("greeting", &"hello").await?;
let greeting: Option<String> = cache.get("greeting").await?;
assert_eq!(greeting.as_deref(), Some("hello"));

Implementations

impl Cache

pub fn new(store: impl CacheStore) -> Self

Builds a cache over a custom CacheStore.

pub fn in_memory() -> Self

Builds a cache over the default in-memory store (MemoryStore).

pub fn default_ttl(self, ttl: Duration) -> Self

Sets the TTL applied by set when no explicit TTL is given.

Without this, set stores entries with no expiry (they live until evicted by the store’s capacity limit).

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

Returns the value stored under key, or None if absent or expired.

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

Stores value under key using the cache’s default TTL.

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

Stores value under key, expiring it after ttl.

A zero ttl means the entry never expires.

pub async fn get_or_set<T, F, Fut>( &self, key: &str, ttl: Option<Duration>, init: F, ) -> Result<T>

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

Returns the cached value under key, or computes it with init, stores it (with ttl, falling back to the default TTL), and returns it.

This is the cache-aside pattern in one call: a hit returns immediately without running init; a miss runs init once and caches the result.

pub async fn delete(&self, key: &str) -> Result<()>

Removes the entry under key, if any.

pub async fn clear(&self) -> Result<()>

Removes every entry from the cache.

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.

impl FromRequest for Cache

fn from_request( ctx: &RequestContext, ) -> impl Future<Output = Result<Self>> + Send

Resolves Self from the request context.