Skip to main content

SessionConfig

Struct SessionConfig 

Source
pub struct SessionConfig {
Show 16 fields pub stateless: bool, pub cookie_refresh_cache: CookieRefreshCache, pub secondary_storage: Option<Arc<dyn CacheAdapter>>, pub store_in_database: bool, pub preserve_in_database: bool, pub additional_fields: IndexMap<String, FieldConfig>, pub expires_in: Duration, pub update_age: Option<Duration>, pub disable_session_refresh: bool, pub defer_session_refresh: bool, pub fresh_age: Option<Duration>, pub cookie_name: String, pub cookie_secure: bool, pub cookie_http_only: bool, pub cookie_same_site: SameSite, pub cookie_cache: Option<CookieCacheConfig>,
}
Expand description

Session-specific configuration

Fields§

§stateless: bool

No durable server session authority. Session records are instance-local in memory; no SQL session rows are read or written. Captured caches remain replayable until their embedded expiry or cache version/secret invalidation.

§cookie_refresh_cache: CookieRefreshCache

Stateless envelope renewal. Stateful deployments ignore this policy.

§secondary_storage: Option<Arc<dyn CacheAdapter>>

Shared secondary session backend for stateful deployments.

§store_in_database: bool

Also persist session rows when a secondary backend is configured.

§preserve_in_database: bool

Retain ended database sessions for auditing; cache misses never fall back to them.

§additional_fields: IndexMap<String, FieldConfig>

Additional fields accepted by session input and output policies.

§expires_in: Duration

Session expiration duration

§update_age: Option<Duration>

How often to refresh the session expiry (as a Duration).

A read refreshes when expires_at - expires_in + update_age is due. This uses the stored expiry, including application overrides, rather than the row’s last update timestamp. None refreshes on every read unless refresh is disabled or deferred.

§disable_session_refresh: bool

If true, sessions are never automatically refreshed on access.

§defer_session_refresh: bool

Defer refresh and expired-row deletion during GET session reads. POST /get-session performs these writes when enabled; otherwise that method is rejected with 405. Expired browser cookies are still cleared.

§fresh_age: Option<Duration>

Session freshness window, defaulting to one day. None or zero skips the freshness restriction; a positive window checks creation time.

§cookie_name: String

Cookie name for session token

§cookie_secure: bool

Cookie settings

§cookie_http_only: bool§cookie_same_site: SameSite§cookie_cache: Option<CookieCacheConfig>

Optional cookie-based session cache to avoid DB lookups.

When enabled, session data is cached in a signed/encrypted cookie. SessionManager checks the cookie cache before hitting the database.

Implementations§

Source§

impl SessionConfig

Source

pub fn stateless(self) -> Self

Select cookie-only sessions, installing the pinned no-store defaults. Configure cookie_cache afterwards to override strategy, lifetime, version, or renewal. Existing database defaults are unchanged.

Source

pub fn has_server_session_store(&self) -> bool

Whether deployment has durable server session storage.

Trait Implementations§

Source§

impl Clone for SessionConfig

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for SessionConfig

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for SessionConfig

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> ErasedDestructor for T
where T: 'static,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FromRef<T> for T
where T: Clone,

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
Source§

impl<A, B, T> HttpServerConnExec<A, B> for T
where B: Body,

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more