Skip to main content

OpenAuthBuilder

Struct OpenAuthBuilder 

Source
pub struct OpenAuthBuilder { /* private fields */ }
Expand description

Builder for constructing an OpenAuth instance.

The builder mirrors common OpenAuthOptions setters and can also attach database adapters, plugins, social providers, and custom endpoints.

Implementations§

Source§

impl OpenAuthBuilder

Source

pub fn new() -> OpenAuthBuilder

Create a builder with default options and no adapter.

Source

pub fn options(self, options: OpenAuthOptions) -> OpenAuthBuilder

Replace all options used by the builder.

Source

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

Set the public base URL used for redirects, cookies, and generated URLs.

Source

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

Set the URL path prefix for auth endpoints.

Source

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

Set the primary application secret.

Source

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

Replace rate limit configuration.

Source

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

Replace session configuration.

Source

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

Replace user model and lifecycle configuration.

Source

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

Replace password authentication configuration.

Source

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

Replace account linking and account model configuration.

Source

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

Replace advanced runtime configuration.

Source

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

Enable or disable production-mode behavior.

Source

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

Register an OpenAuth plugin.

Source

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

Register a social OAuth provider.

Source

pub fn adapter<A>(self, adapter: A) -> OpenAuthBuilder
where A: DbAdapter + 'static,

Attach a database adapter by value.

Source

pub fn adapter_arc(self, adapter: Arc<dyn DbAdapter>) -> OpenAuthBuilder

Attach a shared database adapter.

Source

pub fn endpoint(self, endpoint: AuthEndpoint) -> OpenAuthBuilder

Add one synchronous endpoint to the router.

Source

pub fn endpoints(self, endpoints: Vec<AuthEndpoint>) -> OpenAuthBuilder

Add multiple synchronous endpoints to the router.

Source

pub fn async_endpoint(self, endpoint: AsyncAuthEndpoint) -> OpenAuthBuilder

Add one async endpoint to the router.

Source

pub fn async_endpoints( self, endpoints: Vec<AsyncAuthEndpoint>, ) -> OpenAuthBuilder

Add multiple async endpoints to the router.

Source

pub fn build(self) -> Result<OpenAuth, OpenAuthError>

Build the configured OpenAuth instance.

Trait Implementations§

Source§

impl Default for OpenAuthBuilder

Source§

fn default() -> OpenAuthBuilder

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> 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: Sized + 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: Sized + 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, 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