Struct BiometricEffects 

pub struct BiometricEffects<'a, 'b, S: AppState> { /* private fields */ }

Convenience builder for standard biometric host capabilities.

Implementations

impl<'a, 'b, S: AppState> BiometricEffects<'a, 'b, S>

pub fn availability(self) -> EffectBuilder<'a, 'b, S>

Queries local biometric support and enrollment state.

Use this before presenting a biometric-only path. The result tells the app whether the host supports biometric verification, whether credentials are enrolled, which modalities may be available, and whether device credential fallback is possible.

pub fn authenticate( self, request: BiometricAuthenticateRequest, ) -> EffectBuilder<'a, 'b, S>

Asks the host to authenticate the current local user.

request.reason should explain why verification is needed before the platform prompt appears. The success action receives BiometricAuthenticateResult, which reports the modality and whether a device credential fallback was used.

pub fn cancel_authentication(self) -> EffectBuilder<'a, 'b, S>

Cancels an active biometric authentication prompt where the host permits it.

Use this when the screen that requested verification is closed or the app changes state before the user responds. Some platform prompts cannot be cancelled programmatically after display.