Skip to main content

TwoFactorApi

better_auth_api::plugins::two_factor

Struct TwoFactorApi 

Source 
pub struct TwoFactorApi<'a, S: AuthSchema> { /* private fields */ }
Expand description

Server-only Two Factor endpoints bound to this instance’s registered options. These operations have no public HTTP routes.

Implementations§

Source§

impl<'a, S: AuthSchema> TwoFactorApi<'a, S>

Source

pub fn from_context(context: &'a AuthContext<S>) -> AuthResult<Self>

Bind to the plugin configuration installed on this auth instance.

Source

pub fn with_request(self, source: NativeRequest<'a>) -> Self

Preserve an explicit native Request for dynamic runtime resolution.

Source

pub async fn generate_totp(&self, body: Option<Value>) -> AuthResult<String>

Validate a native body and generate a TOTP using the registered digit and period options.

Source

pub async fn view_backup_codes( &self, body: Option<Value>, ) -> AuthResult<Vec<String>>

Validate and coerce the supplied user ID, then read the stored backup codes.

Auto Trait Implementations§

§

impl<'a, S> !RefUnwindSafe for TwoFactorApi<'a, S>

§

impl<'a, S> !UnwindSafe for TwoFactorApi<'a, S>

§

impl<'a, S> Freeze for TwoFactorApi<'a, S>
where &'a AuthContext<S>: Freeze,

§

impl<'a, S> Send for TwoFactorApi<'a, S>
where &'a AuthContext<S>: Send,

§

impl<'a, S> Sync for TwoFactorApi<'a, S>
where &'a AuthContext<S>: Sync,

§

impl<'a, S> Unpin for TwoFactorApi<'a, S>
where &'a AuthContext<S>: Unpin,

§

impl<'a, S> UnsafeUnpin for TwoFactorApi<'a, S>
where &'a AuthContext<S>: UnsafeUnpin,

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<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

Source§

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

Source§

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

Source§

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

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

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

fn try_from(value: U) -> Result<T, !>

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