Struct CacheStore 

pub struct CacheStore { /* private fields */ }

The application’s handle on the cache.

Holds an Arc<dyn Cache> so the driver is a boot-time decision, and is itself a Cache, so a handler can call cache.remember(...) on it directly without unwrapping anything.

Implementations

impl CacheStore

pub fn from_config(config: &Config) -> Result<Self>

Build the driver named in the application configuration.

Deliberately synchronous and non-connecting: an application must boot even when Redis is momentarily down. Call CacheStore::verify when failing fast is what you want instead.

pub fn build(settings: &CacheConfig) -> Result<Self>

pub fn from_driver(store: impl Cache) -> Self

Wrap a driver that was built by hand.

pub fn driver_handle(&self) -> Arc<dyn Cache>

The underlying driver, for a caller that needs Arc<dyn Cache>.

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

Prove the store actually works, for a doctor command or a boot check.

Trait Implementations

impl Cache for CacheStore

Delegation, so CacheStore is usable everywhere a Cache is — including picking up every default method and all of CacheExt.

fn driver(&self) -> &'static str

The driver’s name, used in cache.hit / cache.miss events and in error messages. Telescope shows it as the store column.

fn get<'a>(&'a self, key: &'a str) -> BoxFuture<'a, Result<Option<Json>>>

Fetch a value, or None when it is missing or expired.

fn put<'a>( &'a self, key: &'a str, value: Json, ttl: Duration, ) -> BoxFuture<'a, Result<()>>

Store a value that expires after ttl.

fn forever<'a>(&'a self, key: &'a str, value: Json) -> BoxFuture<'a, Result<()>>

Store a value with no expiry. It still goes away on Cache::flush.

fn forget<'a>(&'a self, key: &'a str) -> BoxFuture<'a, Result<bool>>

Remove a key. Returns whether something was actually there.

fn flush(&self) -> BoxFuture<'_, Result<()>>

Remove everything this store owns.

fn has<'a>(&'a self, key: &'a str) -> BoxFuture<'a, Result<bool>>

Whether a live (unexpired) value exists.

fn increment<'a>(&'a self, key: &'a str, by: i64) -> BoxFuture<'a, Result<i64>>

Add by to a counter, creating it at zero first. Returns the new value.

fn decrement<'a>(&'a self, key: &'a str, by: i64) -> BoxFuture<'a, Result<i64>>

Subtract by from a counter. Returns the new value.

fn increment_within<'a>( &'a self, key: &'a str, by: i64, ttl: Duration, ) -> BoxFuture<'a, Result<i64>>

Increment a counter, giving it ttl only when this call created it.

fn ttl<'a>(&'a self, key: &'a str) -> BoxFuture<'a, Result<Option<Duration>>>

How long until a key expires: None when it is missing or immortal.

fn pull<'a>(&'a self, key: &'a str) -> BoxFuture<'a, Result<Option<Json>>>

Read a value and remove it in one call — Laravel’s Cache::pull.

impl Clone for CacheStore

fn clone(&self) -> CacheStore

Returns a duplicate of the value.

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

Performs copy-assignment from source.