Struct poem::session::Session

pub struct Session { /* private fields */ }

This is supported on crate feature session only.

Session

Implementations

impl Session

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

Get a value from the session.

pub fn set(&self, name: &str, value: impl Serialize)

Sets a key-value pair into the session.

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

Remove value from the session.

pub fn is_empty(&self) -> bool

Returns true is this session does not contain any values, otherwise it returns false.

pub fn entries(&self) -> BTreeMap<String, Value>

Get all raw key-value data from the session

pub fn clear(&self)

Clear the session.

pub fn renew(&self)

Renews the session key, assigning existing session state to new key.

pub fn purge(&self)

Removes session both client and server side.

pub fn status(&self) -> SessionStatus

Returns the status of this session.

Trait Implementations

impl Clone for Session

fn clone(&self) -> Session

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Session

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

Formats the value using the given formatter.

impl Default for Session

fn default() -> Self

Returns the “default value” for a type.

impl<'a> FromRequest<'a> for &'a Session

fn from_request<'life0, 'async_trait>(
    req: &'a Request,
    _body: &'life0 mut RequestBody
) -> Pin<Box<dyn Future<Output = Result<Self>> + Send + 'async_trait>> where
    'a: 'async_trait,
    'life0: 'async_trait,
    Self: 'async_trait, 

Extract from request head and body.

fn from_request_without_body<'async_trait>(
    req: &'a Request
) -> Pin<Box<dyn Future<Output = Result<Self>> + Send + 'async_trait>> where
    'a: 'async_trait,
    Self: Send + 'async_trait, 

Extract from request head.