Enum KeyringError

#[non_exhaustive]
pub enum KeyringError {
    PlatformFailure(Box<dyn Error + Send + Sync>),
    NoStorageAccess(Box<dyn Error + Send + Sync>),
    NoEntry,
    BadEncoding(Vec<u8>),
    TooLong(String, u32),
    Invalid(String, String),
    Ambiguous(Vec<Box<dyn CredentialApi + Send + Sync>>),
}

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.

This enum is non-exhaustive so that more values can be added to it without a SemVer break. Clients should always have default handling for variants they don’t understand.

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.

PlatformFailure(Box<dyn Error + Send + Sync>)

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

NoStorageAccess(Box<dyn Error + Send + Sync>)

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.

Invalid(String, String)

This indicates that one of the entry’s required credential attributes was invalid. The attached value gives the name of the attribute and the reason it’s invalid.

Ambiguous(Vec<Box<dyn CredentialApi + Send + Sync>>)

This indicates that there is more than one credential found in the store that matches the entry. Its value is a vector of the matching credentials.

Trait Implementations

impl Debug for Error

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

Formats the value using the given formatter.

impl Display for Error

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

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(e: KeyringError) -> Self

Converts to this type from the input type.