Struct viz_core::types::Session

pub struct Session { /* private fields */ }

Available on crate feature session only.

A session for the current request.

Implementations

impl Session

pub fn new(data: Data) -> Self

Creates new Session with Data

pub fn status(&self) -> &AtomicU8

Gets status of the session

pub fn lock_data(&self) -> &RwLock<Data>

Gets lock data of the session

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

where T: DeserializeOwned,

Gets a value by the key

Errors

TODO

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

where T: Serialize,

Sets a value by the key

Errors

TODO

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

Removes a key from the session, returning the value at the key if the key was previously in the session.

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

where T: DeserializeOwned,

Removes a value and deserialize

pub fn clear(&self)

Clears the state

pub fn renew(&self)

Renews the new state

pub fn purge(&self)

Destroys the current state from store

pub fn data(&self) -> Result<Data, Error>

Gets all raw key-value data from the session

Errors

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 FromRequest for Session

type Error = Infallible

The type returned in the event of a conversion error.

async fn extract(req: &mut Request) -> Result<Self, Self::Error>

Extracts this type from the HTTP Request.