Struct actix_web::middleware::session::Session

pub struct Session(_);

The high-level interface you use to modify session data.

Session object could be obtained with RequestSession::session method. RequestSession trait is implemented for HttpRequest.

use actix_web::middleware::session::RequestSession;
use actix_web::*;

fn index(mut req: HttpRequest) -> Result<&'static str> {
    // access session data
    if let Some(count) = req.session().get::<i32>("counter")? {
        req.session().set("counter", count + 1)?;
    } else {
        req.session().set("counter", 1)?;
    }

    Ok("Welcome!")
}

Methods

impl Session

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

Get a value from the session.

pub fn set<T: Serialize>(&self, key: &str, value: T) -> Result<()>

Set a value from the session.

pub fn remove(&self, key: &str)

Remove value from the session.

pub fn clear(&self)

Clear the session.

Trait Implementations

impl<S> FromRequest<S> for Session

Extractor implementation for Session type.

use actix_web::middleware::session::Session;

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

    Ok("Welcome!")
}

type Config = ()

Configuration for conversion process

type Result = Session

Future that resolves to a Self

fn from_request(req: &HttpRequest<S>, _: &Self::Config) -> Self::Result

Convert request to a Self

fn extract(req: &HttpRequest<S>) -> Self::Result

Convert request to a Self