Enum KeyringError 

pub enum KeyringError {
    UserNotFound,
    InvalidUser(InvalidFilenameComponent),
    LockPoisoned,
    CorruptSecret {
        length: usize,
    },
    IoError(Error),
    RekeyRollbackFailed {
        cache_error: Error,
        rollback_error: Error,
    },
    KeyringError(Error),
    KeyError(KeyError),
}

An error locating a user, accessing key storage, or decoding a key.

I/O, keyring-backend, and key-decoding errors retain their underlying error as a source and can be converted into this type with From.

Variants

UserNotFound

The requested user could not be found.

InvalidUser(InvalidFilenameComponent)

A user name is not a portable, single filename component.

LockPoisoned

Available on crate feature std only.

A panic poisoned an in-process keyring coordination lock.

CorruptSecret

A stored secret has an invalid length; its contents are never included.

Fields

length: usize

Number of bytes in the stored secret.

IoError(Error)

Available on crate feature std only.

A filesystem or other I/O operation failed.

Available with the std feature.

RekeyRollbackFailed

Available on crate feature std only.

Publishing a rekeyed public key and restoring the previous secret failed.

The backend may retain the new secret. After resolving the storage failures, Keyring::ensure_secret_key repairs the cache from the stored secret without rotating it again.

Fields

cache_error: Error

The failure publishing the public-key cache.

rollback_error: Error

The failure restoring or removing the secret-key entry.

KeyringError(Error)

The keyring backend failed to initialize or access a secret-key entry.

KeyError(KeyError)

A key could not be decoded, for example from a stored public-key file.

Trait Implementations

impl Debug for KeyringError

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

Formats the value using the given formatter.

impl Display for KeyringError

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

Formats the value using the given formatter.

impl Error for KeyringError

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 KeyringError

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<Error> for KeyringError

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<InvalidFilenameComponent> for KeyringError

fn from(source: InvalidFilenameComponent) -> Self

Converts to this type from the input type.

impl From<KeyError> for KeyringError

fn from(source: KeyError) -> Self

Converts to this type from the input type.