Struct PhoneNumberPlugin 

pub struct PhoneNumberPlugin { /* private fields */ }

Phone authentication backed by atomic, single-use verification records.

Implementations

impl PhoneNumberPlugin

pub fn callbacks<S: AuthSchema>( self, callbacks: PhoneNumberCallbacks<S>, ) -> impl AuthPlugin<S>

Attach schema-aware callbacks after configuring the plugin options.

impl PhoneNumberPlugin

pub fn new() -> Self

Use upstream OTP defaults without enabling automatic registration.

pub fn otp_length(self, length: usize) -> Self

Set the generated decimal code length; the default is six digits.

pub fn expires_in(self, seconds: f64) -> Self

Set code validity in seconds, including fractional values; the default is 300. An explicit zero remains zero.

pub fn allowed_attempts(self, attempts: u64) -> Self

Set the incorrect attempt budget; the default is three.

pub fn require_verification(self, require: bool) -> Self

Require a verified number before password sign-in.

pub fn sign_up_on_verification( self, email: impl Fn(&str) -> String + Send + Sync + 'static, ) -> Self

Create users after successful verification with the supplied temporary email.

pub fn temporary_name( self, name: impl Fn(&str) -> String + Send + Sync + 'static, ) -> Self

Generate names for new users; the default name is the phone number.

pub fn send_otp<F, Fut>(self, callback: F) -> Self

where F: Fn(PhoneOtp, AuthRequest) -> Fut + Send + Sync + 'static, Fut: Future<Output = AuthResult<()>> + Send + 'static,

Deliver verification codes through the application’s SMS provider.

pub fn send_password_reset_otp<F, Fut>(self, callback: F) -> Self

where F: Fn(PhoneOtp, AuthRequest) -> Fut + Send + Sync + 'static, Fut: Future<Output = AuthResult<()>> + Send + 'static,

Deliver password reset codes for registered phone numbers.

pub fn verify_otp<F, Fut>(self, callback: F) -> Self

where F: Fn(PhoneOtp, AuthRequest) -> Fut + Send + Sync + 'static, Fut: Future<Output = AuthResult<bool>> + Send + 'static,

Delegate phone verification to the SMS provider instead of checking a stored code.

pub fn phone_number_validator<F, Fut>(self, callback: F) -> Self

where F: Fn(String) -> Fut + Send + Sync + 'static, Fut: Future<Output = AuthResult<bool>> + Send + 'static,

Validate numbers before sending verification codes or accepting password sign-in.

pub fn callback_on_verification<F, Fut>(self, callback: F) -> Self

where F: Fn(PhoneVerification, AuthRequest) -> Fut + Send + Sync + 'static, Fut: Future<Output = AuthResult<()>> + Send + 'static,

Run after persisting the verified user and before returning or issuing a session.

pub async fn consume_otp( &self, ctx: &AuthContext<impl AuthSchema>, req: &AuthRequest, otp: PhoneOtp, ) -> AuthResult<()>

Consume an OTP without updating a user or creating a session.

Trait Implementations

impl<S: AuthSchema> AuthPlugin<S> for PhoneNumberPlugin

fn name(&self) -> &'static str

Plugin name - should be unique

fn routes(&self) -> Vec<AuthRoute>

Routes that this plugin handles

fn on_request<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, req: &'life1 AuthRequest, ctx: &'life2 AuthContext<S>, ) -> Pin<Box<dyn Future<Output = AuthResult<Option<AuthResponse>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Called for each request - return Some(response) to handle, None to pass through

fn on_init<'life0, 'life1, 'async_trait>( &'life0 self, ctx: &'life1 mut AuthInitContext<S>, ) -> Pin<Box<dyn Future<Output = AuthResult<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Called when the plugin is initialized

fn rate_limits(&self) -> AuthResult<Vec<PluginRateLimit>>

Default endpoint limits, overridden by explicit application limits.

fn before_request<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, req: &'life1 AuthRequest, _ctx: &'life2 AuthContext<S>, ) -> Pin<Box<dyn Future<Output = AuthResult<Option<BeforeRequestAction>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Called for a registered endpoint after HTTP body decoding and origin checks.

fn telemetry_plugin_id(&self) -> Option<&'static str>

Return the upstream plugin ID; core option wrappers have no plugin ID.

fn openapi(&self) -> Result<OpenApiPluginMetadata, AuthError>

Document this configured plugin without invoking application field policies.

fn password_hasher(&self) -> Option<Arc<dyn PasswordHasher>>

Select the base password hasher before plugin initialization wraps it.

fn telemetry(&self, _options: &mut PluginTelemetry)

Report configured options without invoking callbacks or initializing the plugin.

fn on_http_request<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, _req: &'life1 AuthRequest, _ctx: &'life2 AuthContext<S>, ) -> Pin<Box<dyn Future<Output = Result<Option<AuthResponse>, AuthError>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, Self: 'async_trait,

Inspect an HTTP request after rate limiting and before endpoint middleware. Native API calls do not run this hook. A response skips endpoint hooks.

fn on_http_response<'life0, 'life1, 'life2, 'life3, 'async_trait>( &'life0 self, _req: &'life1 AuthRequest, _response: &'life2 mut AuthResponse, _ctx: &'life3 AuthContext<S>, ) -> Pin<Box<dyn Future<Output = Result<Option<AuthResponse>, AuthError>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, 'life3: 'async_trait, Self: 'async_trait,

Inspect the HTTP router response, including route misses and body errors. Early HTTP request responses and native endpoint calls skip this hook. A replacement response stops the remaining HTTP response hooks.

fn after_request<'life0, 'life1, 'life2, 'life3, 'async_trait>( &'life0 self, _req: &'life1 AuthRequest, _response: &'life2 mut AuthResponse, _ctx: &'life3 AuthContext<S>, ) -> Pin<Box<dyn Future<Output = Result<(), AuthError>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, 'life3: 'async_trait, Self: 'async_trait,

Inspect or extend the final route response after session cookies are applied.

impl Clone for PhoneNumberPlugin

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Default for PhoneNumberPlugin

fn default() -> Self

Returns the “default value” for a type.