Struct Session 

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

The current visitor’s session, stored in an encrypted cookie.

Values put in the session last until it expires. Flashed values are readable during the next request only, which is how “saved!” messages and old form input survive a redirect.

Implementations

impl Session

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

Reads a value, including values flashed by the previous request.

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

Whether key is set, including values flashed by the previous request.

pub fn put(&self, key: &str, value: impl Serialize) -> Result

Stores a value under key.

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

Removes key and returns its value, if it was set.

pub fn push(&self, key: &str, value: impl Serialize) -> Result<usize>

Appends value to the list stored under key (a new list if there is none; a value that isn’t a list becomes its first item), e.g. the recently viewed products. Returns the list’s new length.

session.push("recent", 42)?;
let views = session.increment("views", 1)?; // 1, then 2, …

pub fn increment(&self, key: &str, by: i64) -> Result<i64>

Adds by (which may be negative) to the number under key, taking a missing or non-numeric value as 0, and returns the new number.

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

Reads a value and removes it.

pub fn set_lifetime(&self, lifetime: Duration)

Keeps this session for lifetime of inactivity instead of SESSION_LIFETIME, e.g. for “remember me” (whole minutes, at least one).

pub fn flash(&self, key: &str, value: impl Serialize) -> Result

Stores a value for the next request only.

pub fn reflash(&self)

Keeps the values flashed by the previous request for one more request.

pub fn keep(&self, keys: &[&str])

Keeps only these of the values flashed by the previous request for one more request (Laravel’s keep), e.g. a status message across a second redirect.

pub fn flash_now(&self, key: &str, value: impl Serialize) -> Result

A flash value for this request only (Laravel’s flash()->now()): the page rendered now sees it in flash, the next request doesn’t. For a handler that renders a page instead of redirecting.

pub fn flash_input(&self, input: &impl Serialize) -> Result

Flashes the submitted form so the next page can refill it with old(). Passwords and Renox’s own fields (_token, _method) are never kept, and the largest values are dropped when the rest wouldn’t fit in the cookie (browsers drop cookies over 4 KB).

pub fn old(&self, field: &str) -> Option<Value>

A field from the input flashed by the previous request. field may be a nested name (items[0][name] or items.0.name) of a form that used them.

pub fn has_old_input(&self) -> bool

Whether the previous request flashed its input (a failed submit), even with no field in it: an unticked checkbox sends nothing, so old() alone can’t tell “unticked” from “not submitted yet”.

pub fn flash_errors(&self, errors: &impl Serialize) -> Result

Flashes validation errors, keyed by field, for the next request.

pub fn flash_errors_in(&self, bag: &str, errors: &impl Serialize) -> Result

Flashes validation errors for the next request in a named bag (Laravel’s error bags), e.g. login when a page has two forms; templates read them with error('email', bag='login').

pub fn errors(&self) -> Map<String, Value>

Validation errors flashed by the previous request, in the default bag (errors flashed in a named bag aren’t here; see errors_in).

pub fn errors_in(&self, bag: &str) -> Map<String, Value>

Validation errors flashed by the previous request in the bag bag.

pub fn error_bag(&self) -> Option<String>

The bag the previous request’s errors were flashed in, if not the default.

pub fn flashed(&self) -> Map<String, Value>

Values flashed by the previous request, except old input and errors.

pub fn token(&self) -> String

The CSRF token forms and HTMX requests must send back.

pub fn regenerate_token(&self)

Issues a new CSRF token, e.g. after logging in.

pub fn flush(&self)

Removes all data and flashed values and issues a new CSRF token.

impl Session

pub async fn prune_expired(db: &Db) -> Result<u64>

Deletes expired rows of the sessions table (SESSION_DRIVER=database) and returns how many; my-app session:prune runs it. Requests also prune now and then, so this is for a quiet app or a schedule.

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.

impl<S: Send + Sync> FromRequestParts<S> for Session

type Rejection = Error

If the extractor fails it’ll use this “rejection” type. A rejection is a kind of error that can be converted into a response.

async fn from_request_parts(parts: &mut Parts, _: &S) -> Result<Self>

Perform the extraction.