Struct SessionStateConfig 

#[non_exhaustive]
pub struct SessionStateConfig {
    pub ttl: Duration,
    pub extend_ttl: TtlExtensionTrigger,
    pub ttl_extension_threshold: Option<TtlExtensionThreshold>,
    pub server_state_creation: ServerStateCreation,
    pub missing_server_state: MissingServerState,
}

Configure the way session state is stored.

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.

ttl: Duration

The time-to-live of the server session state, i.e. how long to keep the server-side state of a session in the storage backend you chose.

This value is also used to control the expiration of the client-side session cookie if SessionCookieConfig::kind is set to SessionCookieKind::Persistent.

Default

The default value is 24 hours.

extend_ttl: TtlExtensionTrigger

The event that triggers the extension of the time-to-live of the current session.

ttl_extension_threshold: Option<TtlExtensionThreshold>

The server will skip TTL extension if the remaining TTL is greater than this threshold. The threshold is a ratio between 0 and 1, interpreted as a percentage of the total TTL.

If set to None, the server will never skip TTL extension.

Performance impact

Setting a sensible threshold will:

• reduce the number of requests to your storage backend
• reduce your server latency by removing a network request from the critical path

Default

By default, the threshold is set to 0.8—i.e. 80% of the total TTL.

Example

Let’s assume that the TTL for a new session is set to 24 hours. With the default threshold of 0.8, the server will skip TTL extension requests if the remaining session TTL is greater than 19.2 hours. In other words, the server expects at most ~0.2 TTL extension requests per hour for each active session, regardless of the number of requests the server receives for that session.

server_state_creation: ServerStateCreation

Determines when the storage backend should be asked to create a new session state record.

missing_server_state: MissingServerState

Determines what happens when there is no server-side state for a pre-existing session (e.g. only the client-side state remains or was ever created).

Trait Implementations

impl Clone for SessionStateConfig

fn clone(&self) -> SessionStateConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SessionStateConfig

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

Formats the value using the given formatter.

impl Default for SessionStateConfig

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SessionStateConfig

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for SessionStateConfig

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

where __S: Serializer,

Serialize this value into the given Serde serializer.