Struct SessionSettings 

pub struct SessionSettings {
    pub cookie_name: String,
    pub cookie_age_secs: Option<u64>,
    pub cookie_path: String,
    pub cookie_domain: Option<String>,
    pub cookie_secure: bool,
    pub cookie_httponly: bool,
    pub cookie_samesite: String,
    pub save_every_request: bool,
}

Available on native and crate feature auth only.

Session configuration fragment.

Maps to the [auth_session] section and composes with the #[settings] macro. Convert into the deprecated SessionConfig via to_config.

The session cookie max age is expressed as cookie_age_secs (an integer number of seconds). None means a browser-session cookie.

Fields

cookie_name: String

Name of the session cookie.

cookie_age_secs: Option<u64>

Maximum cookie age, in seconds. None yields a session cookie.

cookie_path: String

Cookie path.

cookie_domain: Option<String>

Cookie domain. None uses the current domain.

cookie_secure: bool

Whether the cookie sets the Secure flag (HTTPS only).

cookie_httponly: bool

Whether the cookie sets the HttpOnly flag.

cookie_samesite: String

SameSite policy: "strict", "lax", or "none".

save_every_request: bool

Whether to save the session on every request.

Implementations

impl SessionSettings

pub fn to_config(&self) -> SessionConfig

Convert these settings into the deprecated compatibility config.

The legacy SessionConfig uses private fields, so the conversion rebuilds it through SessionConfig::builder.

Trait Implementations

impl Clone for SessionSettings

fn clone(&self) -> SessionSettings

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SessionSettings

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

Formats the value using the given formatter.

impl Default for SessionSettings

fn default() -> SessionSettings

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SessionSettings

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&SessionSettings> for SessionConfig

fn from(settings: &SessionSettings) -> SessionConfig

Converts to this type from the input type.

impl HasSettings<SessionSettings> for SessionSettings

fn get_settings(&self) -> &SessionSettings

Returns a reference to the contained fragment.

impl Serialize for SessionSettings

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.

impl SettingsFragment for SessionSettings

type Accessor = dyn HasSessionSettings

The accessor trait for this fragment.

fn section() -> &'static str

TOML section name (e.g., "cache", "core").

fn field_policies() -> &'static [FieldPolicy]

Returns the default field policies defined by the library author.

fn validate(&self, _profile: &Profile) -> Result<(), ValidationError>

Validate this fragment against the given profile.

impl SettingsNode for SessionSettings

type Schema<Root> = SessionSettingsSchema<Root>

Typed reference schema rooted at Root.

fn schema_at<Root>( path: SettingsPathBuf, ) -> <SessionSettings as SettingsNode>::Schema<Root>

Build typed schema references for this node at the provided path.

fn node_schema() -> SettingsNodeSchema

Build runtime metadata for this node.

impl SettingsValidation for SessionSettings

fn validate(&self, _profile: &Profile) -> Result<(), ValidationError>

Validate this fragment against the given profile.