Type Alias LocalAuthenticationError 

pub type LocalAuthenticationError = LAError;

Backward-compatible alias for the v0.1.x error type name.

Aliased Type

pub enum LocalAuthenticationError {
    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,
    },
}

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