Enum LAError 

#[non_exhaustive]
pub enum LAError {
    InvalidArgument(String),
    TimedOut(String),
    BridgeFailed(String),
    AuthenticationFailed(String),
    UserCancel(String),
    UserFallback(String),
    SystemCancel(String),
    PasscodeNotSet(String),
    BiometryNotAvailable(String),
    BiometryNotEnrolled(String),
    BiometryLockout(String),
    AppCancel(String),
    InvalidContext(String),
    NotInteractive(String),
    CompanionNotAvailable(String),
    BiometryNotPaired(String),
    BiometryDisconnected(String),
    InvalidDimensions(String),
    Other {
        code: i32,
        message: String,
    },
}

Top-level error type returned by this crate.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

InvalidArgument(String)

Invalid input crossed the FFI boundary.

TimedOut(String)

The framework callback did not complete before the bridge timeout elapsed.

BridgeFailed(String)

The Swift bridge failed before reaching the framework call.

AuthenticationFailed(String)

Authentication was not successful because valid credentials were not provided.

UserCancel(String)

Authentication was cancelled by the user.

UserFallback(String)

Authentication was cancelled because the fallback button was tapped.

SystemCancel(String)

Authentication was cancelled by the system.

PasscodeNotSet(String)

Authentication cannot start because no device passcode is configured.

BiometryNotAvailable(String)

Authentication cannot start because biometry is unavailable.

BiometryNotEnrolled(String)

Authentication cannot start because no biometric identities are enrolled.

BiometryLockout(String)

Authentication cannot start because biometry is locked.

AppCancel(String)

Authentication was cancelled by the application.

InvalidContext(String)

The LAContext has already been invalidated.

NotInteractive(String)

Authentication would require UI while interaction is disallowed.

CompanionNotAvailable(String)

Authentication cannot start because no companion device is nearby.

BiometryNotPaired(String)

Authentication cannot start because the paired biometric accessory is unavailable.

BiometryDisconnected(String)

Authentication cannot start because the paired biometric accessory is disconnected.

InvalidDimensions(String)

Authentication cannot start because an embedded UI size is invalid.

Other

Catch-all for unmapped framework or bridge status codes.

Fields

code: i32

message: String

Implementations

impl LAError

pub const fn code(&self) -> i32

Numeric bridge, LAError, or OSStatus code reported by the bridge.

pub fn message(&self) -> &str

Human-readable description returned by the Swift bridge.

pub const fn domain() -> &'static str

LocalAuthentication’s NSError domain string.

pub fn from_code_message(code: i32, message: impl Into<String>) -> Self

Build an error value from a numeric code and message.

Examples found in repository

examples/03_error_codes.rs (line 6)

fn main() {
    let errors = [
        LAError::from_code_message(ffi::la_error::BIOMETRY_LOCKOUT, "biometry locked"),
        LAError::from_code_message(ffi::la_error::COMPANION_NOT_AVAILABLE, "companion missing"),
        LAError::from_code_message(ffi::status::BRIDGE_FAILED, "bridge failed"),
    ];

    println!("domain: {LA_ERROR_DOMAIN}");
    for error in errors {
        println!("{error:?} => {error}");
    }
    println!("✅ error mapping OK");
}

Trait Implementations

impl Clone for LAError

fn clone(&self) -> LAError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for LAError

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

Formats the value using the given formatter.

impl Display for LAError

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

Formats the value using the given formatter.

impl Error for LAError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl PartialEq for LAError

fn eq(&self, other: &LAError) -> 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 LAError

impl StructuralPartialEq for LAError