Struct Session

pub struct Session(/* private fields */);

The primary interface to access and modify session state.

Session is an extractor—you can specify it as an input type for your request handlers and it will be automatically extracted from the incoming request.

use serde_json::Value;
use actix_extended_session::Session;

async fn index(session: Session) -> actix_web::Result<&'static str> {
    // access session data
    if let Some(count) = session.get::<i32>("counter")? {
        session.insert("counter", Value::from(count + 1));
    } else {
        session.insert("counter", Value::from(1));
    }

    Ok("Welcome!")
}

You can also retrieve a Session object from an HttpRequest or a ServiceRequest using SessionExt.

Implementations

impl Session

pub fn get<T: DeserializeOwned>( &self, key: &str, ) -> Result<Option<T>, SessionGetError>

Get a value from the session.

It returns an error if it fails to parse as T the JSON value associated with key.

pub fn entries(&self) -> Ref<'_, Map<String, Value>>

Get all raw key-value data from the session.

Note that values are JSON encoded.

pub fn status(&self) -> SessionStatus

Returns session status.

pub fn insert(&self, key: impl Into<String>, value: Value)

Inserts a key-value pair into the session.

pub fn remove(&self, key: &str) -> Option<Value>

Remove value from the session.

If present, the JSON encoded value is returned.

pub fn clear(&self)

Clear the session.

pub fn purge(&self)

Removes session both client and server side.

pub fn renew(&self)

Renews the session key, assigning existing session state to new key.

pub fn set_lifecycle(&self, next_lifecycle: SessionLifecycle)

Sets the lifecycle of the session cookie.

pub fn get_lifecycle(&self) -> SessionLifecycle

Returns the lifecycle of the session cookie.

Trait Implementations

impl Clone for Session

fn clone(&self) -> Session

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl FromRequest for Session

Extractor implementation for Sessions.

Examples

use actix_extended_session::Session;
use serde_json::Value;

#[get("/")]
async fn index(session: Session) -> Result<impl Responder> {
    // access session data
    if let Some(count) = session.get::<i32>("counter")? {
        session.insert("counter", Value::from(count + 1));
    } else {
        session.insert("counter", Value::from(1));
    }

    let count = session.get::<i32>("counter")?.unwrap();
    Ok(format!("Counter: {}", count))
}

type Error = Error

The associated error which can be returned.

type Future = Ready<Result<Session, Error>>

Future that resolves to a Self.

fn from_request(req: &HttpRequest, _: &mut Payload) -> Self::Future

Create a Self from request parts asynchronously.

fn extract(req: &HttpRequest) -> Self::Future

Create a Self from request head asynchronously.