Struct ntex_session::Session

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

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 ntex_session::Session;
use ntex::web::*;

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

    Ok("Welcome!")
}

Implementations

impl Session

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

Get a value from the session.

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

Set a value from the session.

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

Remove value from the session.

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_session<Err>( data: impl Iterator<Item = (String, String)>, req: &WebRequest<Err> )

pub fn get_changes( res: &mut WebResponse ) -> (SessionStatus, Option<impl Iterator<Item = (String, String)>>)

Trait Implementations

impl<Err> FromRequest<Err> for Session

Extractor implementation for Session type.

use ntex_session::Session;

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

    Ok("Welcome!")
}

type Error = Infallible

The associated error which can be returned.

async fn from_request( req: &HttpRequest, _: &mut Payload ) -> Result<Session, Infallible>

Convert request to a Self