Enum axum_session::SessionMode

pub enum SessionMode {
    Manual,
    OptIn,
    Persistent,
}

Mode at which the Session will function As.

Examples

use axum_session::{SessionConfig, SessionMode};

let config = SessionConfig::default().with_mode(SessionMode::Persistent);

Variants

Manual

Creates a SessionID Without SessionData.The End user must run session.create_data() to create the SessionData. Functions will emit a Info warning and do nothing until Created. Deletes SessionData and cookie if session.store is false. if SessionData.store is true retains SessionData and Syncs with Database. You can Set SessionData.store to true using ‘session.set_store(true)’

OptIn

Always Creates a Session. Deletes SessionData and cookie if session.store is false. if SessionData.store is true retains SessionData and Syncs with Database. You can Set SessionData.store to true using ‘session.set_store(true)’

Persistent

Always Creates a Session Always retains in Memory and syncs with Database.

Implementations

impl SessionMode

pub fn is_opt_in(&self) -> bool

Checks if the Mode is set to only if OptIn or Manual.

pub fn is_manual(&self) -> bool

Checks if the user needs to manually create the SessionData per user. When created the Session will get Set to loaded.

Trait Implementations

impl Clone for SessionMode

fn clone(&self) -> SessionMode

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SessionMode

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

Formats the value using the given formatter.