Struct SessionConfig 

#[non_exhaustive]
pub struct SessionConfig {
    pub cookie_name: String,
    pub ttl: Duration,
    pub secure: bool,
    pub http_only: bool,
    pub same_site: Option<String>,
    pub domain: Option<String>,
    pub path: String,
}

Session configuration

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.

cookie_name: String

Cookie name

ttl: Duration

Session TTL

secure: bool

HTTPS-only cookie

http_only: bool

HttpOnly flag

same_site: Option<String>

SameSite attribute

domain: Option<String>

Domain

path: String

Path

Implementations

impl SessionConfig

pub fn new(cookie_name: String, ttl: Duration) -> Self

Create a new configuration

Examples

use std::time::Duration;
use reinhardt_middleware::session::SessionConfig;

let config = SessionConfig::new("sessionid".to_string(), Duration::from_secs(3600));
assert_eq!(config.cookie_name, "sessionid");
assert_eq!(config.ttl, Duration::from_secs(3600));

pub fn with_secure(self) -> Self

Enable secure cookie

Examples

use std::time::Duration;
use reinhardt_middleware::session::SessionConfig;

let config = SessionConfig::new("sessionid".to_string(), Duration::from_secs(3600))
    .with_secure();
assert!(config.secure);

pub fn with_http_only(self, http_only: bool) -> Self

Set HttpOnly flag

Examples

use std::time::Duration;
use reinhardt_middleware::session::SessionConfig;

let config = SessionConfig::new("sessionid".to_string(), Duration::from_secs(3600))
    .with_http_only(false);
assert!(!config.http_only);

pub fn with_same_site(self, same_site: String) -> Self

Set SameSite attribute

Examples

use std::time::Duration;
use reinhardt_middleware::session::SessionConfig;

let config = SessionConfig::new("sessionid".to_string(), Duration::from_secs(3600))
    .with_same_site("Strict".to_string());

pub fn with_domain(self, domain: String) -> Self

Set domain

Examples

use std::time::Duration;
use reinhardt_middleware::session::SessionConfig;

let config = SessionConfig::new("sessionid".to_string(), Duration::from_secs(3600))
    .with_domain("example.com".to_string());

pub fn with_path(self, path: String) -> Self

Set path

Examples

use std::time::Duration;
use reinhardt_middleware::session::SessionConfig;

let config = SessionConfig::new("sessionid".to_string(), Duration::from_secs(3600))
    .with_path("/app".to_string());
assert_eq!(config.path, "/app");

pub fn from_settings(settings: &Settings) -> Self

Create a SessionConfig from application Settings

Maps Settings.core.security.session_cookie_secure to SessionConfig.secure.

Examples

use reinhardt_conf::Settings;
use reinhardt_middleware::session::SessionConfig;

#[allow(deprecated)]
let settings = Settings::default();
#[allow(deprecated)]
let config = SessionConfig::from_settings(&settings);
assert!(!config.secure);

Trait Implementations

impl Clone for SessionConfig

fn clone(&self) -> SessionConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SessionConfig

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

Formats the value using the given formatter.

impl Default for SessionConfig

fn default() -> Self

Returns the “default value” for a type.