Struct RedisStateStore 

pub struct RedisStateStore { /* private fields */ }

Available on crate feature state-redis only.

A StateStore that persists each entry as a single Redis string under {namespace}:{key}.

The connection is opened in RedisStateStore::connect and reused across all calls — redis::aio::MultiplexedConnection is cheaply cloneable.

Implementations

impl RedisStateStore

pub async fn connect( url: impl AsRef<str>, namespace: impl Into<String>, ) -> Result<RedisStateStore, FaucetError>

Connect to a Redis server and namespace all keys under namespace:.

url follows the standard Redis URL form (redis://[:pass@]host:port/db).

pub fn from_connection( conn: MultiplexedConnection, namespace: impl Into<String>, ) -> Result<RedisStateStore, FaucetError>

Construct from an existing async connection. Useful for tests and for integrators who want to share a connection across multiple stores.

pub fn redis_key(&self, key: &str) -> String

Returns the fully-qualified Redis key for a given state key.

Trait Implementations

impl StateStore for RedisStateStore

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

where 'life0: 'async_trait, 'life1: 'async_trait, RedisStateStore: 'async_trait,

Return the value stored under key, or None if no entry exists.

fn put<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, key: &'life1 str, value: &'life2 Value, ) -> Pin<Box<dyn Future<Output = Result<(), FaucetError>> + Send + 'async_trait>>

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

Store value under key, replacing any previous entry.

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

where 'life0: 'async_trait, 'life1: 'async_trait, RedisStateStore: 'async_trait,

Remove the entry for key. A missing key is not an error.

fn check<'life0, 'life1, 'async_trait>( &'life0 self, ctx: &'life1 CheckContext, ) -> Pin<Box<dyn Future<Output = Result<CheckReport, FaucetError>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, RedisStateStore: 'async_trait,

Run a fast, non-mutating preflight probe (used by faucet doctor).