Enum keyring::error::Error

pub enum Error {
    PlatformFailure(Error),
    NoStorageAccess(Error),
    NoEntry,
    BadEncoding(Vec<u8>),
    TooLong(String, u32),
    WrongCredentialPlatform,
}

Each variant of the Error enum provides a summary of the error. More details, if relevant, are contained in the associated value, which may be platform-specific.

Variants

PlatformFailure(Error)

This indicates runtime failure in the underlying platform storage system. The details of the failure can be retrieved from the attached platform error.

NoStorageAccess(Error)

This indicates that the underlying secure storage holding saved items could not be accessed. Typically this is because of access rules in the platform; for example, it might be that the credential store is locked. The underlying platform error will typically give the reason.

NoEntry

This indicates that there is no underlying credential entry in the platform for this entry. Either one was never set, or it was deleted.

BadEncoding(Vec<u8>)

This indicates that the retrieved password blob was not a UTF-8 string. The underlying bytes are available for examination in the attached value.

TooLong(String, u32)

This indicates that one of the entry’s credential attributes exceeded a length limit in the underlying platform. The attached values give the name of the attribute and the platform length limit that was exceeded.

WrongCredentialPlatform

This indicates that the credential provided to Entry::new_with_credential was for a different platform than the one in use.

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, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Error for Error

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

The lower-level source of this error, if any.

fn backtrace(&self) -> Option<&Backtrace>

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

Returns a stack backtrace, if available, of where this error occurred.

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