Enum KeyError 

pub enum KeyError {
    File(FileError),
    Keyring(Error),
    KeyringWorkerStart(Error),
    KeyringWorkerStopped {
        operation: &'static str,
    },
    Custody {
        operation: &'static str,
        source: Box<dyn Error + Sync + Send>,
    },
    Json {
        operation: &'static str,
        source: Error,
    },
    Hex {
        subject: &'static str,
        source: FromHexError,
    },
    InvalidLength {
        subject: &'static str,
        expected: usize,
        actual: usize,
    },
    SigningKey(Error),
    Encryption(EncryptionError),
    Utf8(FromUtf8Error),
    Base64(DecodeError),
    PassphraseKdf {
        operation: &'static str,
        source: Box<dyn Error + Sync + Send>,
    },
    UnsupportedPassphraseEnvelopeVersion {
        actual: u32,
        expected: u32,
    },
    UnsupportedPassphraseKdf {
        actual: String,
        expected: &'static str,
    },
    WeakArgon2Parameter {
        parameter: &'static str,
        actual: u32,
        minimum: u32,
    },
    PassphraseEnvelopeDecryption,
    SealedBoxDecryption,
    InvalidEd25519PublicKey,
    WeakEd25519PublicKey,
    AllZeroX25519PublicKey,
    AllZeroX25519SharedSecret,
    PlaintextCloudKeyRotation,
    UnretainedKeyRotation,
    ServiceAlreadyRegistered {
        registered: String,
        requested: String,
    },
    EmptyKeyringEntry {
        account: String,
    },
    CloudCredentialsRolledBack {
        operation: &'static str,
    },
    CloudCredentialsSuperseded,
    MasterKeySetupRolledBack {
        operation: &'static str,
    },
    UnexpectedAppleKeyringEntry,
    UnexpectedTestKeyringEntry,
    StoreNotInstalled,
    UnsupportedKeyringPlatform,
    ServiceNotRegistered,
    NoDeviceIdentity,
    IdentityMismatch {
        existing_pubkey_hex: String,
        imported_pubkey_hex: String,
    },
    NoPendingIdentity {
        pending_public_key_hex: String,
    },
    InvalidSecretName {
        name: String,
        reason: String,
    },
    MissingKeychainEntitlement,
    KeychainTemporarilyUnavailable,
}

Variants

File(FileError)

Keyring(Error)

KeyringWorkerStart(Error)

KeyringWorkerStopped

Fields

operation: &'static str

Custody

Fields

operation: &'static str

source: Box<dyn Error + Sync + Send>

Json

Fields

operation: &'static str

source: Error

Hex

Fields

subject: &'static str

source: FromHexError

InvalidLength

Fields

subject: &'static str

expected: usize

actual: usize

SigningKey(Error)

Encryption(EncryptionError)

Utf8(FromUtf8Error)

Base64(DecodeError)

PassphraseKdf

Fields

operation: &'static str

source: Box<dyn Error + Sync + Send>

UnsupportedPassphraseEnvelopeVersion

Fields

actual: u32

expected: u32

UnsupportedPassphraseKdf

Fields

actual: String

expected: &'static str

WeakArgon2Parameter

Fields

parameter: &'static str

actual: u32

minimum: u32

PassphraseEnvelopeDecryption

SealedBoxDecryption

InvalidEd25519PublicKey

WeakEd25519PublicKey

AllZeroX25519PublicKey

AllZeroX25519SharedSecret

PlaintextCloudKeyRotation

UnretainedKeyRotation

ServiceAlreadyRegistered

Fields

registered: String

requested: String

EmptyKeyringEntry

Fields

account: String

CloudCredentialsRolledBack

Fields

operation: &'static str

CloudCredentialsSuperseded

MasterKeySetupRolledBack

Fields

operation: &'static str

UnexpectedAppleKeyringEntry

UnexpectedTestKeyringEntry

StoreNotInstalled

UnsupportedKeyringPlatform

ServiceNotRegistered

NoDeviceIdentity

IdentityMismatch

Fields

existing_pubkey_hex: String

imported_pubkey_hex: String

NoPendingIdentity

Fields

pending_public_key_hex: String

InvalidSecretName

Fields

name: String

reason: String

MissingKeychainEntitlement

The OS refused a Keychain data-protection-store operation with errSecMissingEntitlement (OSStatus -34018). This is not “the binary isn’t signed” — an ad-hoc or Development-signed binary with no keychain-access-groups entitlement at all also gets -34018, and a signed binary that does carry that entitlement with no provisioning profile behind it is killed by the kernel at launch instead. The fix is a team-prefixed keychain-access-groups entitlement backed by an embedded provisioning profile — in Xcode, set DEVELOPMENT_TEAM so automatic signing fetches and embeds one. A build with no team must omit the entitlement entirely, which means it also has no access to the data-protection keychain and will hit this error on first use.

KeychainTemporarilyUnavailable

The OS refused this keychain operation with errSecInteractionNotAllowed (OSStatus -25308): the keychain is locked, the display is asleep, or the login session cannot show UI. Nothing is wrong with the entry or with this process’s entitlements — the same operation succeeds once the session unlocks, so a caller that needs the key should say so and try again rather than treat the store as broken or the key as absent.

Trait Implementations

impl Debug for KeyError

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

Formats the value using the given formatter.

impl Display for KeyError

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

Formats the value using the given formatter.

impl Error for KeyError

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<DecodeError> for KeyError

fn from(source: DecodeError) -> KeyError

Converts to this type from the input type.

impl From<EncryptionError> for KeyError

fn from(source: EncryptionError) -> KeyError

Converts to this type from the input type.

impl From<FileError> for KeyError

fn from(source: FileError) -> KeyError

Converts to this type from the input type.

impl From<FromUtf8Error> for KeyError

fn from(source: FromUtf8Error) -> KeyError

Converts to this type from the input type.

impl From<KeyError> for BootstrapError

fn from(source: KeyError) -> BootstrapError

Converts to this type from the input type.

impl From<KeyError> for CircleError

fn from(source: KeyError) -> Self

Converts to this type from the input type.

impl From<KeyError> for DevicePairingError

fn from(source: KeyError) -> DevicePairingError

Converts to this type from the input type.

impl From<KeyError> for DevicePairingTransportError

fn from(source: KeyError) -> DevicePairingTransportError

Converts to this type from the input type.

impl From<KeyError> for IdentityError

fn from(source: KeyError) -> IdentityError

Converts to this type from the input type.

impl From<KeyError> for MasterKeyError

fn from(source: KeyError) -> MasterKeyError

Converts to this type from the input type.

impl From<KeyError> for SealError

fn from(source: KeyError) -> SealError

Converts to this type from the input type.

impl From<KeyError> for StorageError

fn from(source: KeyError) -> StorageError

Converts to this type from the input type.

impl From<KeyError> for SyncError

fn from(source: KeyError) -> SyncError

Converts to this type from the input type.