Struct actix_session::storage::RedisActorSessionStore

pub struct RedisActorSessionStore { /* private fields */ }

This is supported on crate feature redis-actor-session only.

Use Redis as session storage backend.

use actix_web::{web, App, HttpServer, HttpResponse, Error};
use actix_session::{SessionMiddleware, storage::RedisActorSessionStore};
use actix_web::cookie::Key;

// The secret key would usually be read from a configuration file/environment variables.
fn get_secret_key() -> Key {
    // [...]
}

#[actix_web::main]
async fn main() -> std::io::Result<()> {
    let secret_key = get_secret_key();
    let redis_connection_string = "127.0.0.1:6379";
    HttpServer::new(move ||
            App::new()
            .wrap(
                SessionMiddleware::new(
                    RedisActorSessionStore::new(redis_connection_string),
                    secret_key.clone()
                )
            )
            .default_service(web::to(|| HttpResponse::Ok())))
        .bind(("127.0.0.1", 8080))?
        .run()
        .await
}

Implementation notes

RedisActorSessionStore leverages actix-redis’s RedisActor implementation - each thread worker gets its own connection to Redis.

Limitations

RedisActorSessionStore does not currently support establishing authenticated connections to Redis. Use RedisSessionStore if you need TLS support.

Implementations

impl RedisActorSessionStore

pub fn builder<S: Into<String>>(
    connection_string: S
) -> RedisActorSessionStoreBuilder

A fluent API to configure RedisActorSessionStore.

It takes as input the only required input to create a new instance of RedisActorSessionStore—a connection string for Redis.

pub fn new<S: Into<String>>(connection_string: S) -> RedisActorSessionStore

Create a new instance of RedisActorSessionStore using the default configuration. It takes as input the only required input to create a new instance of RedisActorSessionStore - a connection string for Redis.

Trait Implementations

impl SessionStore for RedisActorSessionStore

fn load<'life0, 'life1, 'async_trait>(
    &'life0 self,
    session_key: &'life1 SessionKey
) -> Pin<Box<dyn Future<Output = Result<Option<HashMap<String, String>>, LoadError>> + 'async_trait>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait, 

Loads the session state associated to a session key.

fn save<'life0, 'life1, 'async_trait>(
    &'life0 self,
    session_state: HashMap<String, String>,
    ttl: &'life1 Duration
) -> Pin<Box<dyn Future<Output = Result<SessionKey, SaveError>> + 'async_trait>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait, 

Persist the session state for a newly created session.

fn update<'life0, 'life1, 'async_trait>(
    &'life0 self,
    session_key: SessionKey,
    session_state: HashMap<String, String>,
    ttl: &'life1 Duration
) -> Pin<Box<dyn Future<Output = Result<SessionKey, UpdateError>> + 'async_trait>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait, 

Updates the session state associated to a pre-existing session key.

fn delete<'life0, 'life1, 'async_trait>(
    &'life0 self,
    session_key: &'life1 SessionKey
) -> Pin<Box<dyn Future<Output = Result<(), Error>> + 'async_trait>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait, 

Deletes a session from the store.