Struct AnonymousPlugin 

pub struct AnonymousPlugin { /* private fields */ }

Anonymous sign-in with persisted identities and post-sign-in account linking.

Implementations

impl AnonymousPlugin

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

Attach schema-aware callbacks after configuring plugin options.

impl AnonymousPlugin

pub fn new() -> Self

Use upstream defaults for anonymous sign-in and account cleanup.

pub fn email_domain_name(self, domain: impl Into<String>) -> Self

Use this domain for generated placeholder emails.

pub fn disable_delete_anonymous_user(self, disable: bool) -> Self

Disable explicit deletion and post-link anonymous identity cleanup.

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

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

Supply an email generator; an empty result uses the default generator.

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

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

Generate a name from the sign-in request; an empty result uses Anonymous.

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

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

Transfer application data before the anonymous identity is deleted.

Trait Implementations

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

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 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 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 = AuthResult<()>> + Send + 'async_trait>>

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

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

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 rate_limits(&self) -> Result<Vec<PluginRateLimit>, AuthError>

Default endpoint limits, overridden by explicit application limits.

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.

impl Clone for AnonymousPlugin

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 AnonymousPlugin

fn default() -> Self

Returns the “default value” for a type.