Skip to main content

RustAuthOptions

Struct RustAuthOptions 

Source
pub struct RustAuthOptions {
Show 26 fields pub app_name: Option<String>, pub base_url: Option<String>, pub base_path: Option<String>, pub secret: Option<String>, pub secrets: Vec<SecretEntry>, pub trusted_origins: TrustedOriginOptions, pub disabled_paths: Vec<String>, pub session: SessionOptions, pub user: UserOptions, pub email_password: EmailPasswordOptions, pub email_verification: EmailVerificationOptions, pub password: PasswordOptions, pub account: AccountOptions, pub verification: VerificationOptions, pub hooks: GlobalHooksOptions, pub on_api_error: OnApiErrorOptions, pub init_database_hooks: InitDatabaseHooksOptions, pub database_hooks: Vec<PluginDatabaseHook>, pub logger: LoggerOptions, pub advanced: AdvancedOptions, pub rate_limit: RateLimitOptions, pub secondary_storage: Option<Arc<dyn SecondaryStorage>>, pub plugins: Vec<AuthPlugin>, pub mode: DeploymentMode, pub telemetry: TelemetryOptions, pub experimental: ExperimentalOptions,
}
Expand description

Top-level RustAuth configuration.

Database hooks can be registered in two ways:

Both paths are merged at runtime; they are not mutually exclusive.

§Deployment mode

Use Self::deployment_mode or the convenience setters Self::production / Self::development to control whether development-oriented security defaults are allowed. See DeploymentMode for the full precedence matrix.

Fields§

§app_name: Option<String>§base_url: Option<String>§base_path: Option<String>§secret: Option<String>§secrets: Vec<SecretEntry>§trusted_origins: TrustedOriginOptions§disabled_paths: Vec<String>§session: SessionOptions§user: UserOptions§email_password: EmailPasswordOptions§email_verification: EmailVerificationOptions§password: PasswordOptions§account: AccountOptions§verification: VerificationOptions§hooks: GlobalHooksOptions§on_api_error: OnApiErrorOptions§init_database_hooks: InitDatabaseHooksOptions§database_hooks: Vec<PluginDatabaseHook>§logger: LoggerOptions§advanced: AdvancedOptions§rate_limit: RateLimitOptions§secondary_storage: Option<Arc<dyn SecondaryStorage>>§plugins: Vec<AuthPlugin>§mode: DeploymentMode§telemetry: TelemetryOptions§experimental: ExperimentalOptions

Implementations§

Source§

impl RustAuthOptions

Source

pub fn new() -> Self

Source

pub fn app_name(self, app_name: impl Into<String>) -> Self

Source

pub fn base_url(self, base_url: impl Into<String>) -> Self

Source

pub fn base_path(self, base_path: impl Into<String>) -> Self

Source

pub fn secret(self, secret: impl Into<String>) -> Self

Source

pub fn secrets(self, secrets: Vec<SecretEntry>) -> Self

Source

pub fn trusted_origins(self, trusted_origins: TrustedOriginOptions) -> Self

Source

pub fn disabled_path(self, path: impl Into<String>) -> Self

Append one disabled route path.

Source

pub fn push_disabled_path(self, path: impl Into<String>) -> Self

Append one disabled route path (alias for Self::disabled_path).

Source

pub fn disabled_paths<I, S>(self, paths: I) -> Self
where I: IntoIterator<Item = S>, S: Into<String>,

Replace the full disabled-path list.

Source

pub fn set_disabled_paths<I, S>(self, paths: I) -> Self
where I: IntoIterator<Item = S>, S: Into<String>,

Replace the full disabled-path list (alias for Self::disabled_paths).

Source

pub fn session(self, session: SessionOptions) -> Self

Source

pub fn user(self, user: UserOptions) -> Self

Source

pub fn email_password(self, email_password: EmailPasswordOptions) -> Self

Source

pub fn email_verification( self, email_verification: EmailVerificationOptions, ) -> Self

Source

pub fn password(self, password: PasswordOptions) -> Self

Source

pub fn account(self, account: AccountOptions) -> Self

Source

pub fn verification(self, verification: VerificationOptions) -> Self

Source

pub fn advanced(self, advanced: AdvancedOptions) -> Self

Source

pub fn rate_limit(self, rate_limit: RateLimitOptions) -> Self

Source

pub fn hooks(self, hooks: GlobalHooksOptions) -> Self

Source

pub fn on_api_error(self, on_api_error: OnApiErrorOptions) -> Self

Source

pub fn init_database_hooks(self, hooks: InitDatabaseHooksOptions) -> Self

Structured init-time hooks for core models. See RustAuthOptions for when to prefer this over Self::database_hook.

Source

pub fn database_hook(self, hook: PluginDatabaseHook) -> Self

Append a low-level database hook (custom models or plugin tables). See RustAuthOptions for when to prefer Self::init_database_hooks.

Source

pub fn logger(self, logger: LoggerOptions) -> Self

Source

pub fn secondary_storage(self, storage: Arc<dyn SecondaryStorage>) -> Self

Attach secondary storage. The value is already wrapped in Arc.

Source

pub fn secondary_storage_arc(self, storage: Arc<dyn SecondaryStorage>) -> Self

Attach secondary storage (alias for Self::secondary_storage).

Source

pub fn plugin(self, plugin: AuthPlugin) -> Self

Append one plugin to the options list.

Source

pub fn push_plugin(self, plugin: AuthPlugin) -> Self

Append one plugin (alias for Self::plugin).

Source

pub fn plugins(self, plugins: Vec<AuthPlugin>) -> Self

Append multiple plugins to the options list.

Like chaining .plugin repeatedly. To replace the full list, use .set_plugins.

Source

pub fn extend_plugins(self, plugins: Vec<AuthPlugin>) -> Self

Append multiple plugins (alias for Self::plugins).

Source

pub fn set_plugins(self, plugins: Vec<AuthPlugin>) -> Self

Replace the full plugin list.

Source

pub fn deployment_mode(self, mode: DeploymentMode) -> Self

Set deployment posture explicitly.

Source

pub fn production(self, production: bool) -> Self

Enable or disable explicit production posture.

Source

pub fn development(self, development: bool) -> Self

Enable or disable explicit development posture.

Source

pub fn explicit_production(&self) -> bool

Returns true when options request explicit production API error sanitization.

Source

pub fn production_error_posture(&self) -> bool

Returns true when options request explicit production API error sanitization, or when DeploymentMode::Auto and RUST_ENV=production.

Source

pub fn telemetry(self, telemetry: TelemetryOptions) -> Self

Source

pub fn experimental(self, experimental: ExperimentalOptions) -> Self

Trait Implementations§

Source§

impl Clone for RustAuthOptions

Source§

fn clone(&self) -> RustAuthOptions

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 RustAuthOptions

Source§

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

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

impl Default for RustAuthOptions

Source§

fn default() -> RustAuthOptions

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

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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

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