Struct actix_identity::config::IdentityMiddlewareBuilder

pub struct IdentityMiddlewareBuilder { /* private fields */ }

A fluent builder to construct an IdentityMiddleware instance with custom configuration parameters.

Use IdentityMiddleware::builder to get started!

Implementations

impl IdentityMiddlewareBuilder

pub fn id_key(self, key: &'static str) -> Self

Set a custom key to identify the user in the session.

pub fn last_visit_unix_timestamp_key(self, key: &'static str) -> Self

Set a custom key to store the last visited unix timestamp.

pub fn login_unix_timestamp_key(self, key: &'static str) -> Self

Set a custom key to store the login unix timestamp.

pub fn logout_behaviour(self, logout_behaviour: LogoutBehaviour) -> Self

Determines how Identity::logout affects the current session.

By default, the current session is purged (LogoutBehaviour::PurgeSession).

pub fn login_deadline(self, deadline: Option<Duration>) -> Self

Automatically logs out users after a certain amount of time has passed since they logged in, regardless of their activity pattern.

If set to:

• None: login deadline is disabled.
• Some(duration): login deadline is enabled and users will be logged out after duration has passed since their login.

By default, login deadline is disabled.

pub fn visit_deadline(self, deadline: Option<Duration>) -> Self

Automatically logs out users after a certain amount of time has passed since their last visit.

If set to:

• None: visit deadline is disabled.
• Some(duration): visit deadline is enabled and users will be logged out after duration has passed since their last visit.

By default, visit deadline is disabled.

pub fn build(self) -> IdentityMiddleware

Finalises the builder and returns an IdentityMiddleware instance.

Trait Implementations

impl Clone for IdentityMiddlewareBuilder

fn clone(&self) -> IdentityMiddlewareBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for IdentityMiddlewareBuilder

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

Formats the value using the given formatter.