Struct CookieContext 

pub struct CookieContext<S>(/* private fields */);

Manages server-side sessions identified by a cookie.

Construct with CookieContext::builder. Use as a Tower Layer to load sessions from incoming requests, then extract CookieSession<S> in handlers.

Also implements FromRequestParts (via FromRef) so you can extract it in handlers to create or remove sessions.

Implementations

impl CookieContext<()>

pub fn builder() -> CookieSessionBuilder<()>

Create a CookieSessionBuilder to configure the session store and cookie options.

impl<S: 'static> CookieContext<S>

pub fn get_cookie(&self, session_id: SessionId) -> Cookie

Build a cookie for the given session ID using the configured cookie options.

pub async fn create_session(&self, state: S) -> Result<Cookie, Response>

Create a new session, store it, and return a Set-Cookie cookie.

pub async fn remove_session_jar( &self, jar: &CookieJar, ) -> Result<Option<CookieSession<S>>, Response>

Remove the session identified by the cookie in the given jar.

pub async fn remove_session_cookie( &self, cookie: &Cookie, ) -> Result<Option<CookieSession<S>>, Response>

Remove the session identified by the given cookie.

pub async fn remove_session( &self, session_id: &SessionId, ) -> Result<Option<CookieSession<S>>, Response>

Remove the session with the given ID from the store.

pub fn build_cookie(&self, name: impl Into<Cow<'static, str>>) -> CookieBuilder

Create a cookie builder with the configured options and a custom name.

pub fn cookie_builder(&self) -> &CookieBuilder

Return a reference to the underlying cookie builder.

pub async fn remove_before(&self, deadline: u64) -> Result<(), Response>

Remove all sessions created before deadline (Unix timestamp in seconds).

pub async fn load_from_cookie( &self, cookie: &Cookie, ) -> Result<Option<CookieSession<S>>, Response>

Load a session from the store using a cookie’s value as the session ID.

Trait Implementations

impl<S> Clone for CookieContext<S>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<S, U> FromRequestParts<S> for CookieContext<U>

where CookieContext<U>: FromRef<S>, S: Send + Sync,

type Rejection = Infallible

If the extractor fails it’ll use this “rejection” type. A rejection is a kind of error that can be converted into a response.

async fn from_request_parts( _parts: &mut Parts, state: &S, ) -> Result<Self, Self::Rejection>

Perform the extraction.

impl<SERV, T> Layer<SERV> for CookieContext<T>

where T: 'static,

type Service = CookieService<T, SERV>

The wrapped service

fn layer(&self, inner: SERV) -> Self::Service

Wrap the given service with the middleware, returning a new service that has been decorated with the middleware.