Struct RedisSessionBackend 

pub struct RedisSessionBackend { /* private fields */ }

Available on crate feature session-redis and crate feature middleware and native only.

Session backend backed by Redis.

Sessions are stored as JSON strings under the key <prefix><session_id>. Redis native TTL (SET ... EX) is used for expiry so that Redis handles garbage collection automatically.

Example

use reinhardt_middleware::RedisSessionBackend;

let backend = RedisSessionBackend::new_from_url("redis://127.0.0.1/")
    .expect("failed to connect to Redis")
    .with_key_prefix("myapp:session:".to_string());

Implementations

impl RedisSessionBackend

pub fn new_from_url(url: &str) -> Result<RedisSessionBackend, RedisError>

Available on crate features standard or middleware only.

Create a new backend from a Redis connection URL.

The connection is not established until the first operation is performed; this constructor only validates the URL format.

pub fn with_key_prefix(self, prefix: String) -> RedisSessionBackend

Available on crate features standard or middleware only.

Override the key prefix used when storing sessions in Redis.

Defaults to "session:".

Trait Implementations

impl AsyncSessionBackend for RedisSessionBackend

fn load<'life0, 'life1, 'async_trait>( &'life0 self, id: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<Option<SessionData>, Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, RedisSessionBackend: 'async_trait,

Load a session by ID.

Returns None if the key does not exist in Redis or if the stored session has already expired according to its own expires_at field (the Redis TTL is the authoritative expiry, but we double-check).

fn save<'life0, 'life1, 'async_trait>( &'life0 self, session: &'life1 SessionData, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, RedisSessionBackend: 'async_trait,

Persist a session to Redis with a TTL derived from expires_at.

If expires_at is already in the past the session is not stored.

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

where 'life0: 'async_trait, 'life1: 'async_trait, RedisSessionBackend: 'async_trait,

Remove a session from Redis.

fn touch<'life0, 'life1, 'async_trait>( &'life0 self, id: &'life1 str, ttl: Duration, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, RedisSessionBackend: 'async_trait,

Refresh the Redis TTL for an existing session without rewriting the payload.