Skip to main content

SessionStore

Struct SessionStore 

Source
pub struct SessionStore { /* private fields */ }
Expand description

Low-level database-backed session store.

Handles all CRUD operations on the modo_sessions table. Application code should rarely interact with SessionStore directly; use crate::SessionManager (the axum extractor) for request-scoped session operations instead.

SessionStore is cheaply cloneable and is intended to be registered as a managed service so it can be injected into background jobs.

Implementations§

Source§

impl SessionStore

Source

pub fn new( db: &DbPool, config: SessionConfig, cookie_config: CookieConfig, ) -> Self

Create a new store backed by db with the given session and cookie config.

Source

pub fn config(&self) -> &SessionConfig

Return a reference to the session configuration.

Source

pub fn cookie_config(&self) -> &CookieConfig

Return a reference to the cookie configuration.

Source

pub async fn create( &self, meta: &SessionMeta, user_id: &str, data: Option<Value>, ) -> Result<(SessionData, SessionToken), Error>

Insert a new session for user_id and return the persisted SessionData together with the plaintext SessionToken (to be set in the cookie).

After inserting, LRU eviction is applied if the user has exceeded SessionConfig::max_sessions_per_user.

Source

pub async fn read(&self, id: &SessionId) -> Result<Option<SessionData>, Error>

Load a session by its ID. Returns None if not found (does not check expiry — call read_by_token for expiry-aware lookup).

Source

pub async fn read_by_token( &self, token: &SessionToken, ) -> Result<Option<SessionData>, Error>

Load a non-expired session by plaintext token (hashes it internally).

Returns None if no matching, non-expired session is found.

Source

pub async fn destroy(&self, id: &SessionId) -> Result<(), Error>

Delete a session by ID.

Source

pub async fn rotate_token(&self, id: &SessionId) -> Result<SessionToken, Error>

Replace the token for a session with a newly generated one and return the new plaintext token. The session ID and all other fields are unchanged.

Source

pub async fn touch( &self, id: &SessionId, new_expires_at: DateTime<Utc>, ) -> Result<(), Error>

Update last_active_at to now and set a new expires_at for a session.

Source

pub async fn update_data( &self, id: &SessionId, data: Value, ) -> Result<(), Error>

Replace the JSON payload stored in a session.

Source

pub async fn destroy_all_for_user(&self, user_id: &str) -> Result<(), Error>

Delete all sessions belonging to user_id.

Source

pub async fn destroy_all_except( &self, user_id: &str, keep: &SessionId, ) -> Result<(), Error>

Delete all sessions belonging to user_id except the one identified by keep.

Source

pub async fn list_for_user( &self, user_id: &str, ) -> Result<Vec<SessionData>, Error>

Return all non-expired sessions for user_id, ordered by most-recently-active first.

Source

pub async fn cleanup_expired(&self) -> Result<u64, Error>

Delete all sessions whose expires_at is in the past.

Returns the number of rows deleted. Called automatically by the cleanup-job feature’s cron job.

Trait Implementations§

Source§

impl Clone for SessionStore

Source§

fn clone(&self) -> SessionStore

Returns a duplicate of the value. Read more
1.0.0 · 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<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> FromRef<T> for T
where T: Clone,

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
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> 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 = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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
Source§

impl<A, B, T> HttpServerConnExec<A, B> for T
where B: Body,