Struct SessionStore 

pub struct SessionStore { /* private fields */ }

Implementations

impl SessionStore

pub fn new(cache: BoxedCache) -> Self

pub fn ttl(self, ttl: Duration) -> Self

Set the per-session TTL. Default is 2 weeks.

pub async fn save(&self, session: &Session) -> Result<String, SessionError>

Store session under a new ID and return it. Use this at login, so the user gets a fresh ID. To update a session that already exists, use Self::save_with_id.

Errors

A cache or serialization error.

pub async fn save_with_id( &self, id: &str, session: &Session, ) -> Result<(), SessionError>

Store session under id, replacing any existing entry.

Errors

A cache or serialization error.

pub async fn load(&self, id: &str) -> Result<Option<Session>, SessionError>

Load a session by ID. Missing, expired and unreadable entries all give Ok(None).

Errors

A cache error. A value that fails to parse gives Ok(None) instead, so a stored-format change does not 500 every request.

pub async fn destroy(&self, id: &str) -> Result<(), SessionError>

Delete the session, as on logout. Does nothing for an unknown ID.

Errors

A cache error.

pub async fn touch(&self, id: &str) -> Result<bool, SessionError>

Extend the session’s TTL without changing its contents. Call it on each request to keep active users signed in.

Errors

A cache error. Returns false when the session is gone.

Trait Implementations

impl Clone for SessionStore

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.