Skip to main content

OpenAuthOptions

Struct OpenAuthOptions 

Source
pub struct OpenAuthOptions {
Show 18 fields 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_verification: EmailVerificationOptions, pub password: PasswordOptions, pub account: AccountOptions, pub advanced: AdvancedOptions, pub rate_limit: RateLimitOptions, pub plugins: Vec<AuthPlugin>, pub social_providers: Vec<Arc<dyn SocialOAuthProvider>>, pub production: bool, pub telemetry: TelemetryOptions, pub experimental: ExperimentalOptions,
}
Expand description

Top-level OpenAuth configuration.

Fields§

§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_verification: EmailVerificationOptions§password: PasswordOptions§account: AccountOptions§advanced: AdvancedOptions§rate_limit: RateLimitOptions§plugins: Vec<AuthPlugin>§social_providers: Vec<Arc<dyn SocialOAuthProvider>>§production: bool§telemetry: TelemetryOptions§experimental: ExperimentalOptions

Implementations§

Source§

impl OpenAuthOptions

Source

pub fn new() -> Self

Source

pub fn builder() -> 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

Source

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

Source

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

Source

pub fn user(self, user: UserOptions) -> 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 advanced(self, advanced: AdvancedOptions) -> Self

Source

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

Source

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

Source

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

Source

pub fn social_provider<P>(self, provider: P) -> Self

Source

pub fn social_provider_arc(self, provider: Arc<dyn SocialOAuthProvider>) -> Self

Source

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

Source

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

Source

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

Trait Implementations§

Source§

impl Clone for OpenAuthOptions

Source§

fn clone(&self) -> OpenAuthOptions

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 OpenAuthOptions

Source§

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

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

impl Default for OpenAuthOptions

Source§

fn default() -> OpenAuthOptions

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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
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

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