Enum Error 

#[non_exhaustive]
pub enum Error {
    NotAvailable,
    KeyNotFound {
        label: String,
    },
    DuplicateLabel {
        label: String,
    },
    InvalidLabel {
        reason: String,
    },
    SignFailed {
        detail: String,
    },
    EncryptFailed {
        detail: String,
    },
    DecryptFailed {
        detail: String,
    },
    AuthDenied {
        label: String,
    },
    AuthRequired {
        label: String,
        detail: String,
    },
    UserCancelled {
        label: String,
    },
    KeyOperation {
        operation: String,
        detail: String,
    },
    TamperDetected {
        path: String,
    },
    RequiresSigning {
        feature: String,
    },
    PolicyNotSupported {
        policy: String,
    },
    PresenceNotAvailable,
    NotImplemented {
        feature: String,
    },
    PolicyMismatch {
        detail: String,
    },
    Config(String),
    Io(Error),
    Memory(String),
}

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.

NotAvailable

The hardware security module is absent, not enrolled, or unreachable.

KeyNotFound

No key with the given label exists in this app’s key store.

Fields

label: String

DuplicateLabel

A key with this label already exists.

Fields

label: String

InvalidLabel

The label is syntactically invalid (empty, too long, or contains illegal characters).

Fields

reason: String

SignFailed

The signing operation failed.

Fields

detail: String

EncryptFailed

The encryption operation failed.

Fields

detail: String

DecryptFailed

The decryption operation failed; the ciphertext may be corrupt or have been tampered with.

Fields

detail: String

AuthDenied

The OS keychain / TPM ACL has a Deny entry for this binary.

Fields

label: String

AuthRequired

User authentication is required but the device is locked or no GUI session is available.

Fields

label: String

detail: String

UserCancelled

The user dismissed the biometric or PIN prompt.

Fields

label: String

KeyOperation

A lower-level key operation failed.

Fields

operation: String

detail: String

TamperDetected

File HMAC mismatch — the file has been modified outside the API.

Fields

path: String

RequiresSigning

Returned from factory construction (not first use) when a config option requires a code-signed binary with the named entitlement/feature.

The requested configuration requires a code-signed binary with a specific entitlement.

Fields

feature: String

PolicyNotSupported

The backend cannot enforce the requested AccessPolicy (e.g. BiometricOnly on Linux).

Returned from generate_key() when the backend cannot enforce the requested AccessPolicy (e.g. BiometricOnly on Linux keyring/TPM).

Fields

policy: String

PresenceNotAvailable

sign_with_presence(Strict, ...) was called on a platform without biometric support.

Returned from sign_with_presence() when PresenceMode::Strict is requested but the platform has no user-presence support.

NotImplemented

This API is not yet fully implemented on this platform. Check the feature string.

Fields

feature: String

PolicyMismatch

The key’s stored access policy does not match. Regenerate the key.

This typically indicates the key was generated with a different policy and should be regenerated.

Fields

detail: String

Config(String)

A configuration value is invalid.

Io(Error)

An I/O error occurred.

Memory(String)

An in-process memory protection operation failed (guard-page allocation, mlock, etc.).

Trait Implementations

impl Debug for Error

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

Formats the value using the given formatter.

impl Display for Error

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

Formats the value using the given formatter.

impl Error for Error

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 From<Error> for Error

fn from(source: Error) -> Self

Converts to this type from the input type.