Struct highnoon::filter::session::SessionFilter

pub struct SessionFilter { /* private fields */ }

A filter for implementing basic session support

This filter requires that the Context implements HasSession

Implementations

impl SessionFilter

pub fn new(store: impl SessionStore + Send + Sync + 'static) -> SessionFilter

Create a new session filter using the provided store The default cookie name is DEFAULT_COOKIE_NAME and expiry is set to one hour

pub fn with_cookie_name(self, name: impl Into<Cow<'static, str>>) -> Self

Set the name of the cookie used to store the session ID

pub fn with_expiry(self, expiry: Duration) -> Self

Set the expiry time set on the session ID cookie

pub fn with_callback<F>(self, callback: F) -> Selfwhere
    F: Fn(&mut Cookie<'_>) + Send + Sync + 'static,

Set a callback function to be used to customise the session ID cookie. The callback is called with the cookie before it is stored in the headers so you can change most settings (changing the name or value of the cookie may prevent sessions from working, so only change settings like same site, secure, etc…)

Trait Implementations

impl<S> Filter<S> for SessionFilterwhere
    S: State,
    S::Context: HasSession,

fn apply<'life0, 'life1, 'async_trait>(
    &'life0 self,
    req: Request<S>,
    next: Next<'life1, S>
) -> Pin<Box<dyn Future<Output = Result<Response>> + Send + 'async_trait>>where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait,