Trait salvo::prelude::SessionStore

source · 
pub trait SessionStore: Debug + Send + Sync + Clone + 'static {
    // Required methods
    fn load_session<'life0, 'async_trait>(
        &'life0 self,
        cookie_value: String
    ) -> Pin<Box<dyn Future<Output = Result<Option<Session>, Error>> + Send + 'async_trait>>
       where 'life0: 'async_trait,
             Self: 'async_trait;
    fn store_session<'life0, 'async_trait>(
        &'life0 self,
        session: Session
    ) -> Pin<Box<dyn Future<Output = Result<Option<String>, Error>> + Send + 'async_trait>>
       where 'life0: 'async_trait,
             Self: 'async_trait;
    fn destroy_session<'life0, 'async_trait>(
        &'life0 self,
        session: Session
    ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>
       where 'life0: 'async_trait,
             Self: 'async_trait;
    fn clear_store<'life0, 'async_trait>(
        &'life0 self
    ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>
       where 'life0: 'async_trait,
             Self: 'async_trait;
}
Available on crate feature session only.
Expand description

An async session backend.

Required Methods§

source

fn load_session<'life0, 'async_trait>( &'life0 self, cookie_value: String ) -> Pin<Box<dyn Future<Output = Result<Option<Session>, Error>> + Send + 'async_trait>>
where 'life0: 'async_trait, Self: 'async_trait,

Get a session from the storage backend.

The input is expected to be the value of an identifying cookie. This will then be parsed by the session middleware into a session if possible

source

fn store_session<'life0, 'async_trait>( &'life0 self, session: Session ) -> Pin<Box<dyn Future<Output = Result<Option<String>, Error>> + Send + 'async_trait>>
where 'life0: 'async_trait, Self: 'async_trait,

Store a session on the storage backend.

The return value is the value of the cookie to store for the user that represents this session

source

fn destroy_session<'life0, 'async_trait>( &'life0 self, session: Session ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>
where 'life0: 'async_trait, Self: 'async_trait,

Remove a session from the session store

source

fn clear_store<'life0, 'async_trait>( &'life0 self ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>
where 'life0: 'async_trait, Self: 'async_trait,

Empties the entire store, destroying all sessions

Object Safety§

This trait is not object safe.

Implementors§