Struct MockSession 

pub struct MockSession {
    pub id: String,
    pub user: Option<TestUser>,
    pub data: HashMap<String, Value>,
    pub csrf_token: String,
    pub created_at: i64,
    pub expires_at: Option<i64>,
    pub invalidated: bool,
}

A mock session for testing session-based functionality.

This simulates a server-side session that can store user information and arbitrary session data.

Example

// Anonymous session
let anon_session = MockSession::anonymous();

// Authenticated session
let auth_session = MockSession::authenticated(TestUser::authenticated("alice"));

// Session with custom data
let session = MockSession::anonymous()
    .with_data("cart_id", serde_json::json!("abc123"))
    .with_data("theme", serde_json::json!("dark"));

Fields

id: String

Session ID.

user: Option<TestUser>

The authenticated user, if any.

data: HashMap<String, Value>

Session data storage.

csrf_token: String

CSRF token for the session.

created_at: i64

Session creation timestamp (Unix epoch seconds).

expires_at: Option<i64>

Session expiration timestamp (Unix epoch seconds).

invalidated: bool

Whether the session has been invalidated.

Implementations

impl MockSession

pub fn anonymous() -> Self

Create a new anonymous session.

pub fn authenticated(user: TestUser) -> Self

Create an authenticated session with the given user.

pub fn from_identity(identity: &SessionIdentity) -> Self

Create an authenticated session from a SessionIdentity.

Bridges the shared identity type to the server_fn test context. Creates a stub TestUser internally to maintain is_authenticated() compatibility.

pub fn with_id(self, id: impl Into<String>) -> Self

Set a custom session ID.

pub fn with_data(self, key: impl Into<String>, value: impl Into<Value>) -> Self

Add session data.

pub fn with_csrf_token(self, token: impl Into<String>) -> Self

Set the CSRF token.

pub fn with_expiration(self, expires_at: i64) -> Self

Set the session expiration.

pub fn expires_in(self, seconds: i64) -> Self

Set session to expire after the given duration in seconds.

pub fn is_authenticated(&self) -> bool

Check if the session is authenticated.

pub fn is_expired(&self) -> bool

Check if the session has expired.

pub fn is_valid(&self) -> bool

Check if the session is valid (not invalidated and not expired).

pub fn get<T: for<'de> Deserialize<'de>>(&self, key: &str) -> Option<T>

Get session data by key.

pub fn get_raw(&self, key: &str) -> Option<&Value>

Get raw session data by key.

pub fn set(&mut self, key: impl Into<String>, value: impl Into<Value>)

Set session data.

pub fn remove(&mut self, key: &str) -> Option<Value>

Remove session data by key.

pub fn clear_data(&mut self)

Clear all session data (but keep user).

pub fn invalidate(&mut self)

Invalidate the session.

pub fn user_id(&self) -> Option<Uuid>

Get the user ID if authenticated.

pub fn regenerate_id(&mut self)

Regenerate the session ID (for security after login).

pub fn regenerate_csrf(&mut self)

Regenerate the CSRF token.

pub fn verify_csrf(&self, token: &str) -> bool

Verify a CSRF token.

Trait Implementations

impl Clone for MockSession

fn clone(&self) -> MockSession

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MockSession

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

Formats the value using the given formatter.

impl Default for MockSession

fn default() -> MockSession

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for MockSession

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for MockSession

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.