Struct DatabaseSessionStore 

pub struct DatabaseSessionStore { /* private fields */ }

Sessions in a table.

The right default for more than one instance: every process reads the same rows, so a user stays logged in wherever the load balancer sends them.

Implementations

impl DatabaseSessionStore

pub fn new(db: Database) -> Self

A store over db, with two-hour sessions.

pub fn with_lifetime(self, lifetime: Duration) -> Self

Sessions expiring after lifetime.

pub fn migrations() -> Migrator

The migration this driver needs.

Merge it into the application’s migrator:

Migrator::new()
    .create_table::<User>("0001_create_users")
    .merge(DatabaseSessionStore::migrations())

pub async fn prune(&self) -> Result<u64>

Remove every expired row. Returns how many.

Trait Implementations

impl Debug for DatabaseSessionStore

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

Formats the value using the given formatter.

impl SessionStore for DatabaseSessionStore

fn name(&self) -> &str

A label for diagnostics — "memory", "database", "cache", "cookie".

fn read<'a>(&'a self, id: &'a str) -> BoxFuture<'a, Result<Option<SessionData>>>

The data for this id, or None if it is unknown or expired.

fn write<'a>( &'a self, id: &'a str, data: &'a SessionData, ) -> BoxFuture<'a, Result<()>>

Write the data back, refreshing its expiry.

fn destroy<'a>(&'a self, id: &'a str) -> BoxFuture<'a, Result<()>>

Remove a session.

fn gc(&self) -> BoxFuture<'_, Result<u64>>

Discard every expired session. Called periodically, not per request.

fn is_client_side(&self) -> bool

Whether the session travels in the cookie rather than being stored here.

fn encode(&self, id: &str, data: &SessionData) -> Result<String>

The cookie value carrying this session.

fn decode(&self, value: &str) -> Result<(String, Option<SessionData>)>

Recover a session id — and, for a client-side store, its data — from a cookie value.