Struct Session 

pub struct Session { /* private fields */ }

The session of the current request; cheap to clone

Implementations

impl Session

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

A value, if present and of the requested type

pub fn contains(&self, key: &str) -> bool

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

Store a value; creates the session (and its cookie) if needed

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

pub fn clear(&self)

Drop all data but keep the session

pub fn renew(&self)

Give the session a fresh id, keeping its data. Call it whenever the privilege level changes (login, logout, role change) so that an id an attacker planted or learned earlier becomes useless.

pub fn destroy(&self)

Delete the session and its cookie (logout)

pub fn flash(&self, message: impl Into<String>) -> Result<()>

Queue a message for the next page (survives one redirect)

pub fn take_flash(&self) -> Vec<String>

Messages queued with flash; each is returned once

pub fn csrf_token(&self) -> Result<String>

The CSRF token of this session, created on first use. Rotates with renew’s data like any other value. See crate::csrf.

pub fn is_established(&self) -> bool

True when this request belongs to a stored session

Trait Implementations

impl Clone for Session

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.