Struct SessionManager

pub struct SessionManager { /* private fields */ }

provides APIs to interact with user session stores.

Implementations

impl SessionManager

pub fn new( session_duration: Duration, inactive_duration: Duration, prune_rate: Duration, ) -> SessionManager

pub fn is_enabled(&self) -> bool

returns true if sessions are enabled

pub fn enable(&self)

enables sessions

pub fn disable(&self)

disables sessions and clears all existing sessions

pub fn set_session_duration(&self, duration: Duration)

sets the maximum duration that a session may be allowed to persist for regardless of inactivity

pub fn set_inactive_duration(&self, duration: Duration)

sets the expiry duration for sessions

pub fn set_prune_rate(&self, duration: Duration)

sets the prune rate for sessions, will attempt to prune old sessions every duration

pub fn generate_id() -> Uuid

generates a new session id without storing a session

pub fn create_session(&self) -> Uuid

generates a new session and returns the ID

pub fn write_session(&self, session_id: Uuid, key: &str, value: &str) -> bool

writes value to the key-value session store as key for the session_id session store.

pub fn read_session(&self, session_id: Uuid, key: &str) -> Option<String>

reads the value associated with key for the session_id session store.

pub fn clear_session(&self, session_id: Uuid)

empties the session store for session_id

pub fn delete_session(&self, session_id: Uuid)

removes the session store for session_id

pub fn session_exists(&self, session_id: Uuid) -> bool

checks if a session store for session_id exists

pub fn add_session(&self, session_id: Uuid) -> bool

Accepts a session id, creates a session with it if the ID is not already for an existing session. Returns false if the session id was not good or the store already contains the ID

pub fn get_or_create_session( &self, cookies: &HashMap<String, Cookie<'_>>, ) -> Option<(Uuid, bool)>

tries to get an existing session if a session does not exist, a session is created. The returned tuple contains the session id and a boolean, the boolean is true if the created session is new, if it is false, the session id is for an existing session.

pub fn prune(&self)

Trait Implementations

impl Default for SessionManager

fn default() -> Self

Returns the “default value” for a type.