Struct SessionData 

pub struct SessionData {
    pub session_id: String,
    pub user_id: String,
    pub created_at: DateTime<Utc>,
    pub expires_at: DateTime<Utc>,
    pub last_activity: DateTime<Utc>,
    pub ip_address: Option<String>,
    pub user_agent: Option<String>,
    pub data: HashMap<String, Value>,
}

Session data stored in the backend.

All fields are public for serialization flexibility. When constructing a new session prefer SessionData::new which initialises timestamps consistently.

Chainable construction

let session = SessionData::new("sess-1", "user-1", Duration::from_secs(3600))
    .ip_address("127.0.0.1")
    .user_agent("Mozilla/5.0")
    .with_data("role", json!("admin"));

The older SessionData::with_metadata helper sets both IP and user-agent in a single call and remains available.

Invariants (not enforced at the type level)

• created_at <= last_activity
• created_at < expires_at
• last_activity is updated on every authenticated access.
• data may contain arbitrary application-specific key/value pairs — the framework never reads them.

Fields

session_id: String

Session ID

user_id: String

User ID associated with this session

created_at: DateTime<Utc>

When the session was created

expires_at: DateTime<Utc>

When the session expires

last_activity: DateTime<Utc>

Last activity timestamp

ip_address: Option<String>

IP address of the session

user_agent: Option<String>

User agent

data: HashMap<String, Value>

Custom session data

Implementations

impl SessionData

pub fn new( session_id: impl Into<String>, user_id: impl Into<String>, expires_in: Duration, ) -> Self

Create a new session with consistent timestamps.

Arguments

• session_id - Unique session identifier (typically a UUID)
• user_id - Associated user ID
• expires_in - Session lifetime from now

Use with_metadata to attach IP and user-agent information after construction.

Panics

If expires_in conversion to chrono::Duration fails catastrophically.

pub fn is_expired(&self) -> bool

Check if the session has expired.

pub fn time_until_expiry(&self) -> Duration

Return the remaining lifetime of this session.

Returns Duration::ZERO when the session has already expired.

pub fn is_active(&self) -> bool

Check if the session is still active (not expired).

pub fn update_activity(&mut self)

Update the last activity timestamp.

pub fn with_metadata( self, ip_address: Option<String>, user_agent: Option<String>, ) -> Self

Set session metadata (IP address and user-agent) in one call.

pub fn ip_address(self, ip: impl Into<String>) -> Self

Set the client IP address.

pub fn user_agent(self, ua: impl Into<String>) -> Self

Set the client user-agent string.

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

Add a custom data entry (chainable).

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

Add custom data to the session.

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

Get custom data from the session.

Trait Implementations

impl Clone for SessionData

fn clone(&self) -> SessionData

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SessionData

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SessionData

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for SessionData

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

where __S: Serializer,

Serialize this value into the given Serde serializer.