Skip to main content

SessionConfig

Struct SessionConfig 

Source
pub struct SessionConfig {
    pub store_session_in_database: Option<bool>,
    pub preserve_session_in_database: Option<bool>,
    pub expires_in: Option<Duration>,
    pub update_age: Option<Duration>,
    pub disable_session_refresh: Option<bool>,
    pub defer_session_refresh: bool,
    pub fresh_age: Option<Duration>,
    pub cookie_cache: Option<CookieCacheConfig>,
    pub bearer: Option<BearerConfig>,
    pub additional_fields: Option<IndexMap<String, SessionFieldConfig>>,
}
Expand description

Session-specific configuration

Fields§

§store_session_in_database: Option<bool>

Persist sessions in the database as well as secondary storage.

§preserve_session_in_database: Option<bool>

Keep ended database sessions for audit and disable database fallback on cache misses.

§expires_in: Option<Duration>

Session expiration duration. Omission uses seven days.

§update_age: Option<Duration>

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

Refresh when the remaining lifetime falls below expires_in - update_age. Omission uses one day. Zero refreshes on every authoritative read.

§disable_session_refresh: Option<bool>

If true, sessions are never automatically refreshed on access.

§defer_session_refresh: bool

Report needsRefresh on GET /get-session and refresh on POST /get-session. Upstream rejects the POST form with 405 unless this is enabled.

§fresh_age: Option<Duration>

Session freshness window. A session younger than this is considered “fresh” (useful for step-up auth or sensitive operations).

§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.

§bearer: Option<BearerConfig>

Enable the upstream Bearer plugin behavior for session tokens. API keys use their own plugin configuration.

§additional_fields: Option<IndexMap<String, SessionFieldConfig>>

Application session fields accepted by /update-session and included in session responses. None preserves omission; an explicitly empty map remains configured.

Implementations§

Source§

impl SessionConfig

Source

pub fn expires_in(&self) -> Duration

Read the effective session lifetime. Omission and zero use seven days.

Source

pub fn update_age(&self) -> Duration

Read the effective refresh interval. Omission uses one day; zero refreshes on every read.

Source

pub fn disable_session_refresh(&self) -> bool

Read the effective refresh policy. Omission permits refresh.

Source

pub fn store_session_in_database(&self) -> bool

Read the database persistence policy used with secondary storage.

Source

pub fn preserve_session_in_database(&self) -> bool

Read the ended-session retention policy. Omission permits deletion.

Source§

impl SessionConfig

Source

pub fn fields(&self) -> &IndexMap<String, SessionFieldConfig>

Runtime fields. An omitted map has no fields.

Source

pub fn fields_mut(&mut self) -> &mut IndexMap<String, SessionFieldConfig>

Configure fields, creating an explicitly present map when omitted.

Source

pub fn field_schema(&self) -> UserConfig

Source

pub fn default_fields(&self) -> AuthResult<FieldMap>

Evaluate creation defaults without validating or transforming session input.

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 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<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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> 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