pub struct IdentityMiddlewareBuilder { /* private fields */ }
Expand description

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

Use IdentityMiddleware::builder to get started!

Implementations§

source§

impl IdentityMiddlewareBuilder

source

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

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

source

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

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

source

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

Set a custom key to store the login unix timestamp.

source

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

source

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.

source

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.

source

pub fn build(self) -> IdentityMiddleware

Finalises the builder and returns an IdentityMiddleware instance.

Trait Implementations§

source§

impl Clone for IdentityMiddlewareBuilder

source§

fn clone(&self) -> IdentityMiddlewareBuilder

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for IdentityMiddlewareBuilder

source§

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

Formats the value using the given formatter. 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> 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

§

type Output = T

Should always be Self
source§

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

§

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

§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

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

§

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

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

§

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