Struct axum_session_auth::config::AuthConfig

pub struct AuthConfig<Type>where
    Type: Eq + Default + Clone + Send + Sync + Hash + Serialize + DeserializeOwned + 'static,{
    pub(crate) cache: bool,
    pub(crate) anonymous_user_id: Option<Type>,
    pub(crate) session_id: Cow<'static, str>,
    pub(crate) max_age: Duration,
}

Configuration for how the Auth service is used.

Examples

use axum_session_auth::AuthConfig;

let config = AuthConfig::<i64>::default();

Fields

cache: bool

Allows caching of Users, Must tell the database to reload user when a change is made when cached.

anonymous_user_id: Option<Type>

The anonymous user id for logging unlogged users into a default guest like account. ID 0 is None

session_id: Cow<'static, str>

Session Id for the User ID storage.

max_age: Duration

Age the cache is allowed to live for if no visits are made.

Implementations

impl<Type> AuthConfig<Type>where Type: Eq + Default + Clone + Send + Sync + Hash + Serialize + DeserializeOwned + 'static,

pub fn new() -> Self

Creates Default configuration of AuthConfig. This is equivalent to the AuthConfig::<i64>::default().

pub fn set_cache(self, cache: bool) -> Self

Sets the auth session to cache the users data for faster reload. if set to true and you update a users Data you must also trigger the reload of the user to reload the new changes on their next request.

Examples

use axum_session_auth::AuthConfig;

let config = AuthConfig::<i64>::default().set_cache(true);

pub fn with_anonymous_user_id(self, id: Option<Type>) -> Self

Set the auto logged in user ID if the user making the request is not logged in yet. Do not use ID 0 as this stands for the default Return when no user is loaded.

Examples

use axum_session_auth::AuthConfig;

let config = AuthConfig::<i64>::default().with_anonymous_user_id(Some(0));

pub fn with_max_age(self, time: Duration) -> Self

Set’s the auth session’s max_age (expiration time).

This is used to deturmine how long a User Account is cached per last request

Examples

use axum_session_auth::AuthConfig;
use chrono::Duration;

let config = AuthConfig::<i64>::default().with_max_age(Some(Duration::days(2)));

pub fn with_session_id(self, session_id: impl Into<Cow<'static, str>>) -> Self

Set’s the auth session’s token for session storage.

Examples

use axum_session_auth::AuthConfig;

let config = AuthConfig::<i64>::default().with_session_id("www.helpme.com".to_string());

Trait Implementations

impl<Type> Clone for AuthConfig<Type>where Type: Eq + Default + Clone + Send + Sync + Hash + Serialize + DeserializeOwned + 'static + Clone,

fn clone(&self) -> AuthConfig<Type>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Type> Debug for AuthConfig<Type>where Type: Eq + Default + Clone + Send + Sync + Hash + Serialize + DeserializeOwned + 'static,

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

Formats the value using the given formatter.

impl<Type> Default for AuthConfig<Type>where Type: Eq + Default + Clone + Send + Sync + Hash + Serialize + DeserializeOwned + 'static,

fn default() -> Self

Returns the “default value” for a type.