Struct BiometricPrompt 

#[repr(C)]
pub struct BiometricPrompt {
    pub reason: AzString,
    pub cancel_label: AzString,
    pub allow_device_credential: bool,
}

Configuration for one biometric-auth request — what the OS prompt shows and which fallbacks are allowed. Passed to App::request_biometric_auth.

Strings are plain AzString; an empty string means “use the platform default label” (so callers only override what they care about). This keeps the public surface engine-agnostic and codegen stays a single struct with no nested Option<String> wrappers.

Fields

reason: AzString

Reason shown in the OS prompt — required on iOS (localizedReason; the NSFaceIDUsageDescription plist key is declared separately), shown as the Android subtitle and the Windows / Linux message line. Empty is accepted but discouraged.

cancel_label: AzString

Label for the cancel / negative button (Android requires one; iOS localizedCancelTitle). Empty → platform default (“Cancel”).

allow_device_credential: bool

Allow the OS passcode / PIN / device-credential fallback when biometrics fail or aren’t enrolled. When the user takes that path the result is BiometricResult::FellBackToPasscode. false = biometric-only (iOS …WithBiometrics, Android BIOMETRIC_STRONG without DEVICE_CREDENTIAL).

Implementations

impl BiometricPrompt

pub fn new(reason: AzString) -> BiometricPrompt

Convenience constructor: a biometric-only prompt showing reason, with the platform-default cancel label and no passcode fallback.

Trait Implementations

impl Clone for BiometricPrompt

fn clone(&self) -> BiometricPrompt

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BiometricPrompt

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Default for BiometricPrompt

fn default() -> BiometricPrompt

Returns the “default value” for a type.

impl PartialEq for BiometricPrompt

fn eq(&self, other: &BiometricPrompt) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for BiometricPrompt

impl StructuralPartialEq for BiometricPrompt