Struct SessionStore 

pub struct SessionStore { /* private fields */ }

Available on (crate features standard or middleware) and native only.

Session store with automatic lazy eviction of expired sessions

Performs threshold-based lazy cleanup of expired sessions to prevent unbounded memory growth. Cleanup is triggered inside save whenever the total number of stored sessions exceeds the configured threshold; it is not time-based. The threshold defaults to SessionStore::DEFAULT_CLEANUP_THRESHOLD and can be overridden at construction via SessionStore::with_cleanup_threshold or adjusted at runtime via SessionStore::set_cleanup_threshold.

Implementations

impl SessionStore

pub const DEFAULT_CLEANUP_THRESHOLD: usize = 10_000

Default cleanup threshold: trigger cleanup when session count exceeds 10,000

pub fn new() -> SessionStore

Create a new store with the default cleanup threshold (SessionStore::DEFAULT_CLEANUP_THRESHOLD).

pub fn with_cleanup_threshold(threshold: usize) -> SessionStore

Create a new store with a custom cleanup threshold.

The store triggers a single retain pass inside save whenever the number of stored sessions exceeds threshold.

pub fn set_cleanup_threshold(&self, threshold: usize)

Update the cleanup threshold at runtime.

pub fn get(&self, id: &str) -> Option<SessionData>

Get a session

pub fn save(&self, session: SessionData)

Save a session, with automatic cleanup when threshold is exceeded.

Cleanup is amortized: a full retain scan only runs when crossing the threshold from below, not on every subsequent insert.

pub fn delete(&self, id: &str)

Delete a session

pub fn cleanup(&self)

Clean up expired sessions

pub fn clear(&self)

Clear the store

pub fn len(&self) -> usize

Get the number of sessions

pub fn is_empty(&self) -> bool

Check if the store is empty

Trait Implementations

impl Debug for SessionStore

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

Formats the value using the given formatter.

impl Default for SessionStore

fn default() -> SessionStore

Returns the “default value” for a type.