Struct RedisStore 

pub struct RedisStore { /* private fields */ }

A cache backed by Redis.

Cloning shares one pool, so this can be registered as application state.

Implementations

impl RedisStore

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

Build a store from a URL: redis://[:password@]host:port[/db].

pub fn new(config: RedisConfig, prefix: impl Into<String>) -> Self

pub fn pool(&self) -> &Pool

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

Open a connection now, so a bad URL or a wrong password surfaces at boot.

pub async fn ping(&self) -> Result<String>

PING. Returns PONG, and is the cheapest liveness check there is.

pub async fn expire(&self, key: &str, seconds: u64) -> Result<bool>

EXPIRE key seconds — whole-second precision, which is what the Redis command itself offers. Returns whether the key existed.

pub async fn pexpire(&self, key: &str, ttl: Duration) -> Result<bool>

PEXPIRE key milliseconds, for the sub-second windows a rate limiter wants and EXPIRE cannot express.

pub async fn command(&self, args: &[&[u8]]) -> Result<Value>

Run an arbitrary command. The escape hatch for anything this crate does not wrap; arguments are still length-prefixed, so it cannot be injected.

Trait Implementations

impl Cache for RedisStore

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 RedisStore

fn clone(&self) -> RedisStore

Returns a duplicate of the value.

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

Performs copy-assignment from source.