Struct rocket_session_store::Session

pub struct Session<'s, T: 'static> { /* private fields */ }

A request guard implementing FromRequest to retrive the session based on the cookie from the user.

Implementations

impl<'s, T> Session<'s, T>

pub async fn get(&self) -> SessionResult<Option<T>>

Get the session value from the store.

Returns None if there is no initialized session value or if the value has expired.

pub async fn set(&self, value: T) -> SessionResult<()>

Sets the session value from the store.

This will refresh the expiration timer.

pub async fn touch(&self) -> SessionResult<()>

Refreshes the expiration timer on the sesion in the store.

pub async fn remove(&self) -> SessionResult<()>

Removes the session from the store.

Trait Implementations

impl<'r, 's, T> FromRequest<'r> for Session<'s, T> where
    T: Send + Sync + 'static + Clone,
    'r: 's, 

type Error = ()

The associated error to be returned if derivation fails.

fn from_request<'life0, 'async_trait>(
    request: &'r Request<'life0>
) -> Pin<Box<dyn Future<Output = Outcome<Self, Self::Error>> + Send + 'async_trait>> where
    'r: 'async_trait,
    'life0: 'async_trait,
    Self: 'async_trait, 

Derives an instance of Self from the incoming request metadata.