Skip to main content

BiometricPrompt

Struct BiometricPrompt 

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

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§

Source§

impl BiometricPrompt

Source

pub fn new(reason: AzString) -> Self

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

Trait Implementations§

Source§

impl Clone for BiometricPrompt

Source§

fn clone(&self) -> BiometricPrompt

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for BiometricPrompt

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for BiometricPrompt

Source§

fn default() -> Self

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

impl Eq for BiometricPrompt

Source§

impl PartialEq for BiometricPrompt

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for BiometricPrompt

Auto Trait Implementations§

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<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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.