# Struct actix_session::storage::RedisActorSessionStore

source · [−]

    pub struct RedisActorSessionStore { /* private fields */ }

Expand description

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

source

### impl RedisActorSessionStore

source

#### 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.

source

#### 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

source

### impl SessionStore for RedisActorSessionStore

source

#### 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.

source

#### 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. Read more

source

#### 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.

source

#### 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.

## Auto Trait Implementations

### impl !RefUnwindSafe for RedisActorSessionStore

### impl !Send for RedisActorSessionStore

### impl !Sync for RedisActorSessionStore

### impl Unpin for RedisActorSessionStore

### impl !UnwindSafe for RedisActorSessionStore

## Blanket Implementations

source

### impl<T> Any for T where
T: 'static + ?Sized,

source

#### fn type_id(&self) -> TypeId

Gets the `TypeId` of `self`. Read more

source

### impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

#### fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

### impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

#### fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

### impl<T> From<T> for T

const: unstable · source

#### fn from(t: T) -> T

Returns the argument unchanged.

source

### impl<T> Instrument for T

source

#### fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided `Span`, returning an `Instrumented` wrapper. Read more

source

#### fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current `Span`, returning an `Instrumented` wrapper. Read more

source

### impl<T, U> Into<U> for T where
U: From<T>,

const: unstable · source

#### fn into(self) -> U

Calls `U::from(self)`.

That is, this conversion is whatever the implementation of `From<T> for U` chooses to do.

source

### impl<T> Same<T> for T

#### type Output = T

Should always be `Self`

source

### impl<T, U> TryFrom<U> for T where
U: Into<T>,

#### type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

#### fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

source

### impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

#### type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

const: unstable · source

#### fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

### impl<V, T> VZip<V> for T where
V: MultiLane<T>,

#### fn vzip(self) -> V

source

### impl<T> WithSubscriber for T

source

#### fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,

Attaches the provided `Subscriber` to this type, returning a `WithDispatch` wrapper. Read more

source

#### fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default `Subscriber` to this type, returning a `WithDispatch` wrapper. Read more