Struct SessionData 

#[non_exhaustive]
pub struct SessionData {
    pub id: String,
    pub data: HashMap<String, Value>,
    pub created_at: SystemTime,
    pub last_accessed: SystemTime,
    pub expires_at: SystemTime,
    pub id_holder: Option<ActiveSessionId>,
}

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

Session data

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

id: String

Session ID

data: HashMap<String, Value>

Data

created_at: SystemTime

Creation timestamp

last_accessed: SystemTime

Last access timestamp

expires_at: SystemTime

Expiration timestamp

id_holder: Option<ActiveSessionId>

Back-reference to the request-scoped active session ID holder.

Populated by SessionData::inject from the request extensions; used by regenerate_id to keep the middleware’s Set-Cookie value in sync with the rotated session ID. Never serialized — sessions persisted to a store carry only the data they own. See #3827.

Defaults to None; callers constructing SessionData literally outside the middleware (tests, fixtures) can leave it None because rotation only matters when the session is actively wired into a live request.

Implementations

impl SessionData

pub fn new(ttl: Duration) -> SessionData

Create a new session

pub fn regenerate_id(&mut self) -> String

Rotate the session ID (e.g., after authentication, to prevent session fixation). Updates both self.id and the request-scoped ActiveSessionId so that SessionMiddleware writes the new ID to the response cookie.

Returns the previous ID so callers can delete the stale entry from the store.

See #3827.

pub fn touch(&mut self, ttl: Duration)

Update last access timestamp

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

where T: for<'de> Deserialize<'de>,

Get a value

pub fn set<T>(&mut self, key: String, value: T) -> Result<(), Error>

where T: Serialize,

Set a value

pub fn delete(&mut self, key: &str)

Delete a value

pub fn contains_key(&self, key: &str) -> bool

Check if a key exists

pub fn clear(&mut self)

Clear 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<(), Error>

Formats the value using the given formatter.

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

fn deserialize<__D>( __deserializer: __D, ) -> Result<SessionData, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Injectable for SessionData

fn inject<'life0, 'async_trait>( ctx: &'life0 InjectionContext, ) -> Pin<Box<dyn Future<Output = Result<SessionData, DiError>> + Send + 'async_trait>>

where 'life0: 'async_trait, SessionData: 'async_trait,

Creates an instance of this type by resolving dependencies from the injection context.

fn inject_uncached<'life0, 'async_trait>( ctx: &'life0 InjectionContext, ) -> Pin<Box<dyn Future<Output = Result<Self, DiError>> + Send + 'async_trait>>

where 'life0: 'async_trait, Self: 'async_trait,

Inject without using cache (for cache = false support).

impl Serialize for SessionData

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

where __S: Serializer,

Serialize this value into the given Serde serializer.