Struct RedisCache 

pub struct RedisCache { /* private fields */ }

Redis-backed Cache.

Wraps RedisStore. Values are stored as Redis strings. Arbitrary bytes are encoded as Latin-1 (each byte becomes U+0000..=U+00FF) so a round trip is lossless through the store’s UTF-8 API. Cache::clear deletes only this cache’s prefix (SCAN + DEL); it never sends FLUSHDB.

Construct with RedisCache::connect or RedisCache::new. An empty store prefix is replaced with siderite-cache: so clear cannot wipe a whole database.

Implementations

impl RedisCache

pub fn new(store: RedisStore) -> Self

Wrap store. An empty prefix becomes siderite-cache:.

pub async fn connect(url: &str) -> Result<Self, CacheError>

Open url and namespace keys under siderite-cache:.

Errors

CacheError::Backend when the URL is rejected or Redis cannot be reached.

pub fn store(&self) -> &RedisStore

The underlying store (already prefixed).

Trait Implementations

impl Cache for RedisCache

fn get<'life0, 'life1, 'async_trait>( &'life0 self, key: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<Option<Vec<u8>>, CacheError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Fetch key. Ok(None) when the key is missing or has expired.

fn set<'life0, 'life1, 'async_trait>( &'life0 self, key: &'life1 str, value: Vec<u8>, ttl: Option<Duration>, ) -> Pin<Box<dyn Future<Output = Result<(), CacheError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Store value at key. ttl of None means the entry does not expire.

fn set_if_absent<'life0, 'life1, 'async_trait>( &'life0 self, key: &'life1 str, value: Vec<u8>, ) -> Pin<Box<dyn Future<Output = Result<bool, CacheError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Atomically create a nonexpiring entry only when no live entry exists.

fn set_if_absent_with_ttl<'life0, 'life1, 'async_trait>( &'life0 self, key: &'life1 str, value: Vec<u8>, ttl: Duration, ) -> Pin<Box<dyn Future<Output = Result<bool, CacheError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Atomically create an expiring entry only when no live entry exists.

fn delete<'life0, 'life1, 'async_trait>( &'life0 self, key: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<bool, CacheError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Remove key. Ok(true) when a live entry was removed.

fn increment<'life0, 'life1, 'async_trait>( &'life0 self, key: &'life1 str, by: i64, ) -> Pin<Box<dyn Future<Output = Result<i64, CacheError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Add by to the integer stored at key (Redis INCRBY).

fn increment_with_expiry<'life0, 'life1, 'async_trait>( &'life0 self, key: &'life1 str, by: i64, ttl: Duration, ) -> Pin<Box<dyn Future<Output = Result<i64, CacheError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Atomically add by to a counter and give it an expiry when it has none.

fn clear<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<(), CacheError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Remove every entry this cache is responsible for.

fn admit_marker<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, req: &'life1 AdmitMarker<'life2>, ) -> Pin<Box<dyn Future<Output = Result<Admission, CacheError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Admit a route-cache generation marker (provided; overriding is an optimisation, never a requirement).

fn invalidate_marker<'life0, 'life1, 'life2, 'life3, 'async_trait>( &'life0 self, marker: &'life1 str, epoch_key: &'life2 str, epoch: &'life3 [u8], ttl: Duration, ) -> Pin<Box<dyn Future<Output = Result<(), CacheError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, 'life3: 'async_trait,

Replace the invalidation epoch and delete a marker (provided).

impl Clone for RedisCache

fn clone(&self) -> RedisCache

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RedisCache

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.