Struct SessionHandle 

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

The request’s session, shared between the middleware and the handler.

Request::extension hands out a shared reference, but the middleware has to read the session back after the handler has changed it — so the session lives behind a mutex and both sides hold the same handle. Cloning a handle is cloning an Arc; every clone is the same session.

Implementations

impl SessionHandle

pub fn new(session: Session) -> Self

pub fn lock(&self) -> MutexGuard<'_, Session>

Borrow the session directly.

The guard is not Send, so holding it across an .await will not compile — which is the behaviour we want: a session held open across an await is a session held open across another request.

pub fn with<R>(&self, action: impl FnOnce(&mut Session) -> R) -> R

Run a closure against the session, releasing the lock immediately.

pub fn id(&self) -> String

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

pub fn get_string(&self, key: &str) -> Option<String>

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

pub fn put(&self, key: impl Into<String>, value: impl Into<Json>)

pub fn forget(&self, key: &str) -> Option<Json>

pub fn flush(&self)

pub fn all(&self) -> BTreeMap<String, Json>

pub fn flash(&self, key: impl Into<String>, value: impl Into<Json>)

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

pub fn reflash(&self)

pub fn regenerate(&self) -> String

Rotate the id, keeping the contents. See Session::regenerate.

pub fn invalidate(&self) -> String

Empty the session and rotate the id.

pub fn token(&self) -> String

The CSRF token, generated on first use.

Trait Implementations

impl Clone for SessionHandle

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SessionHandle

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Flash for SessionHandle

The session is where a flashed value lives.

flash writes with the session’s own one-request lifetime, so a value left here is gone after the next request whether or not anybody read it — which is what stops an old error message reappearing on a page three clicks later.

fn flash(&self, key: &str, value: Json)

Leave a value for the next request, and no longer.

fn take(&self, key: &str) -> Option<Json>

Read a value and consume it.

fn peek(&self, key: &str) -> Option<Json>

Read a value and leave it in place.