Struct salvo_extra::session::SessionHandler

pub struct SessionHandler<S> { /* fields omitted */ }

SessionHandler

Implementations

impl<S> SessionHandler<S> where
    S: SessionStore, 

pub fn new(store: S, secret: &[u8]) -> Self

Create new SessionHandler

pub fn with_cookie_path(self, cookie_path: impl AsRef<str>) -> Self

Sets a cookie path for this session middleware. The default for this value is “/”

pub fn with_session_ttl(self, session_ttl: Option<Duration>) -> Self

Sets a session ttl. This will be used both for the cookie expiry and also for the session-internal expiry.

The default for this value is one day. Set this to None to not set a cookie or session expiry. This is not recommended.

pub fn with_cookie_name(self, cookie_name: impl AsRef<str>) -> Self

Sets the name of the cookie that the session is stored with or in.

If you are running multiple tide applications on the same domain, you will need different values for each application. The default value is “tide.sid”

pub fn without_save_unchanged(self) -> Self

Disables the save_unchanged setting. When save_unchanged is enabled, a session will cookie will always be set. With save_unchanged disabled, the session data must be modified from the Default value in order for it to save. If a session already exists and its data unmodified in the course of a request, the session will only be persisted if save_unchanged is enabled.

pub fn with_same_site_policy(self, policy: SameSite) -> Self

Sets the same site policy for the session cookie. Defaults to SameSite::Lax. See incrementally better cookies for more information about this setting

pub fn with_cookie_domain(self, cookie_domain: impl AsRef<str>) -> Self

Sets the domain of the cookie.

Trait Implementations

impl<S: SessionStore> Debug for SessionHandler<S>

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

Formats the value using the given formatter.

impl<S> Handler for SessionHandler<S> where
    S: SessionStore, 

fn handle<'life0, 'life1, 'life2, 'life3, 'life4, 'async_trait>(
    &'life0 self,
    req: &'life1 mut Request,
    depot: &'life2 mut Depot,
    res: &'life3 mut Response,
    ctrl: &'life4 mut FlowCtrl
) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    'life2: 'async_trait,
    'life3: 'async_trait,
    'life4: 'async_trait,
    Self: 'async_trait, 

Handle http request.