Enum identity_iota::storage::KeyStorageErrorKind

#[non_exhaustive]
pub enum KeyStorageErrorKind {
    UnsupportedKeyType,
    KeyAlgorithmMismatch,
    UnsupportedSignatureAlgorithm,
    KeyNotFound,
    Unavailable,
    Unauthenticated,
    RetryableIOFailure,
    SerializationError,
    Unspecified,
}

The cause of the failed key storage operation.

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.

UnsupportedKeyType

Indicates that a user tried to generate a key which the key storage implementation does not support.

KeyAlgorithmMismatch

Indicates an attempt to generate or insert a key with a key type that the key storage implementation deems incompatible with the given signature algorithm.

UnsupportedSignatureAlgorithm

Indicates an attempt to parse a signature algorithm that is not recognized by the key storage implementation.

KeyNotFound

Indicates that the key storage implementation is not able to find the requested key.

Unavailable

Indicates that the storage is unavailable for an unpredictable amount of time.

Occurrences of this variant should hopefully be rare, but could occur if hardware fails, or a hosted key store goes offline.

Unauthenticated

Indicates that an attempt was made to authenticate with the key storage, but the operation did not succeed.

RetryableIOFailure

Indicates an unsuccessful I/O operation that may be retried, such as a temporary connection failure or timeouts.

Returning this error signals to the caller that the operation may be retried with a chance of success. It is at the caller’s discretion whether to retry or not, and how often.

SerializationError

Indicates a failure to serialize or deserialize.

Unspecified

Indicates that something went wrong, but it is unclear whether the reason matches any of the other variants.

When using this variant one may want to attach additional context to the corresponding KeyStorageError. See KeyStorageError::with_custom_message and KeyStorageError::with_source.

Implementations

impl KeyStorageErrorKind

pub const fn as_str(&self) -> &str

Returns the string representation of the error.

Trait Implementations

impl AsRef<str> for KeyStorageErrorKind

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for KeyStorageErrorKind

fn clone(&self) -> KeyStorageErrorKind

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for KeyStorageErrorKind

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

Formats the value using the given formatter.

impl Display for KeyStorageErrorKind

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

Formats the value using the given formatter.