Skip to main content

PhoneNumberCallbacks

better_auth_api::plugins::phone_number

Struct PhoneNumberCallbacks 

Source 
pub struct PhoneNumberCallbacks<S: AuthSchema> { /* private fields */ }
Expand description

Phone callbacks with parsed endpoint input and the complete authentication runtime.

Implementations§

Source§

impl<S: AuthSchema> PhoneNumberCallbacks<S>

Source

pub fn send_otp<F>(self, callback: F) -> Self
where F: Fn(&PhoneOtp, &EndpointContext<'_, S>) -> AuthResult<Option<BackgroundFuture>> + Send + Sync + 'static,

Start verification delivery. Return None for synchronous completion. Retain the endpoint with to_owned when asynchronous delivery needs its context.

Source

pub fn send_password_reset_otp<F>(self, callback: F) -> Self
where F: Fn(&PhoneOtp, &EndpointContext<'_, S>) -> AuthResult<Option<BackgroundFuture>> + Send + Sync + 'static,

Start password reset delivery. Return None for synchronous completion.

Source

pub fn verify_otp<F>(self, callback: F) -> Self
where F: for<'a> Fn(&'a PhoneOtp, &'a EndpointContext<'_, S>) -> PhoneCallbackFuture<'a, bool> + Send + Sync + 'static,

Verify a code using an external provider.

Source

pub fn on_verification<F>(self, callback: F) -> Self
where F: for<'a> Fn(&'a PhoneVerification, &'a EndpointContext<'_, S>) -> PhoneCallbackFuture<'a, ()> + Send + Sync + 'static,

Observe the persisted user before a session is created.

Trait Implementations§

Source§

impl<S: AuthSchema> Default for PhoneNumberCallbacks<S>

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

§

impl<S> !RefUnwindSafe for PhoneNumberCallbacks<S>

§

impl<S> !UnwindSafe for PhoneNumberCallbacks<S>

§

impl<S> Freeze for PhoneNumberCallbacks<S>
where Option<Arc<dyn Fn(&PhoneOtp, &EndpointContext<'_, S>) -> Result<Option<Pin<Box<dyn Future<Output = Result<(), AuthError>> + Send>>>, AuthError> + Send + Sync>>: Freeze, Option<Arc<dyn for<'a> Fn(&'a PhoneOtp, &'a EndpointContext<'_, S>) -> Pin<Box<dyn Future<Output = Result<bool, AuthError>> + Send + 'a>> + Send + Sync>>: Freeze, Option<Arc<dyn for<'a> Fn(&'a PhoneVerification, &'a EndpointContext<'_, S>) -> Pin<Box<dyn Future<Output = Result<(), AuthError>> + Send + 'a>> + Send + Sync>>: Freeze,

§

impl<S> Send for PhoneNumberCallbacks<S>
where Option<Arc<dyn Fn(&PhoneOtp, &EndpointContext<'_, S>) -> Result<Option<Pin<Box<dyn Future<Output = Result<(), AuthError>> + Send>>>, AuthError> + Send + Sync>>: Send, Option<Arc<dyn for<'a> Fn(&'a PhoneOtp, &'a EndpointContext<'_, S>) -> Pin<Box<dyn Future<Output = Result<bool, AuthError>> + Send + 'a>> + Send + Sync>>: Send, Option<Arc<dyn for<'a> Fn(&'a PhoneVerification, &'a EndpointContext<'_, S>) -> Pin<Box<dyn Future<Output = Result<(), AuthError>> + Send + 'a>> + Send + Sync>>: Send,

§

impl<S> Sync for PhoneNumberCallbacks<S>
where Option<Arc<dyn Fn(&PhoneOtp, &EndpointContext<'_, S>) -> Result<Option<Pin<Box<dyn Future<Output = Result<(), AuthError>> + Send>>>, AuthError> + Send + Sync>>: Sync, Option<Arc<dyn for<'a> Fn(&'a PhoneOtp, &'a EndpointContext<'_, S>) -> Pin<Box<dyn Future<Output = Result<bool, AuthError>> + Send + 'a>> + Send + Sync>>: Sync, Option<Arc<dyn for<'a> Fn(&'a PhoneVerification, &'a EndpointContext<'_, S>) -> Pin<Box<dyn Future<Output = Result<(), AuthError>> + Send + 'a>> + Send + Sync>>: Sync,

§

impl<S> Unpin for PhoneNumberCallbacks<S>
where Option<Arc<dyn Fn(&PhoneOtp, &EndpointContext<'_, S>) -> Result<Option<Pin<Box<dyn Future<Output = Result<(), AuthError>> + Send>>>, AuthError> + Send + Sync>>: Unpin, Option<Arc<dyn for<'a> Fn(&'a PhoneOtp, &'a EndpointContext<'_, S>) -> Pin<Box<dyn Future<Output = Result<bool, AuthError>> + Send + 'a>> + Send + Sync>>: Unpin, Option<Arc<dyn for<'a> Fn(&'a PhoneVerification, &'a EndpointContext<'_, S>) -> Pin<Box<dyn Future<Output = Result<(), AuthError>> + Send + 'a>> + Send + Sync>>: Unpin,

§

impl<S> UnsafeUnpin for PhoneNumberCallbacks<S>
where Option<Arc<dyn Fn(&PhoneOtp, &EndpointContext<'_, S>) -> Result<Option<Pin<Box<dyn Future<Output = Result<(), AuthError>> + Send>>>, AuthError> + Send + Sync>>: UnsafeUnpin, Option<Arc<dyn for<'a> Fn(&'a PhoneOtp, &'a EndpointContext<'_, S>) -> Pin<Box<dyn Future<Output = Result<bool, AuthError>> + Send + 'a>> + Send + Sync>>: UnsafeUnpin, Option<Arc<dyn for<'a> Fn(&'a PhoneVerification, &'a EndpointContext<'_, S>) -> Pin<Box<dyn Future<Output = Result<(), AuthError>> + Send + 'a>> + Send + Sync>>: 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