Skip to main content

DbSessionStore

Struct DbSessionStore 

Source
pub struct DbSessionStore { /* private fields */ }
Available on crate features model-mysql or model-postgres or model-sqlite only.
Expand description

Session store backed by a relational database via the model-layer DbPool.

Sessions survive process restarts and are visible to every process that connects to the same database, making this suitable for multi-instance deployments and zero-downtime restarts.

The first call to DbSessionStore::new creates the rws_sessions table if it does not already exist:

CREATE TABLE IF NOT EXISTS rws_sessions (
    id         TEXT    PRIMARY KEY,
    data       TEXT    NOT NULL DEFAULT '',
    expires_at INTEGER NOT NULL
)

Session data is serialized as a URL-encoded string (key1=val1&key2=val2). Expired sessions are not removed automatically — call purge_expired periodically.

All methods are async fn — model-* features imply the http2 feature which provides a tokio runtime.

§Example

use rust_web_server::model::DbPool;
use rust_web_server::session::DbSessionStore;

let pool = DbPool::memory().await?;
let store = DbSessionStore::new(pool, 3600).await?;

let mut sess = store.create().await?;
sess.set("user_id", "42");
store.save(&sess).await?;

let loaded = store.load(&sess.id).await?.unwrap();
assert_eq!(Some("42"), loaded.get("user_id"));

Implementations§

Source§

impl DbSessionStore

Source

pub async fn new(pool: DbPool, ttl_secs: u64) -> Result<Self, DbError>

Open (or reuse) a DbSessionStore backed by pool.

Creates the rws_sessions table on the first call if it is absent. Returns Err if the DDL fails.

Source

pub async fn create(&self) -> Result<Session, DbError>

Create a new empty session and persist it immediately.

Source

pub async fn create_with_id(&self, id: String) -> Result<Session, DbError>

Create a new empty session with a caller-supplied ID and persist it.

Source

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

Load a session by ID. Returns None if unknown or expired.

Source

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

Persist a session’s data back to the store.

Source

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

Delete a session immediately.

Source

pub async fn purge_expired(&self) -> Result<(), DbError>

Delete all sessions whose TTL has elapsed.

Source

pub async fn len(&self) -> Result<usize, DbError>

Total number of sessions in the store, including expired ones not yet purged.

Source

pub async fn is_empty(&self) -> Result<bool, DbError>

true if the store contains no sessions.

Trait Implementations§

Source§

impl Clone for DbSessionStore

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more