pub struct KeyRejected(_);
Expand description

An error parsing or validating a key.

The Display implementation and <KeyRejected as Error>::description() will return a string that will help you better understand why a key was rejected change which errors are reported in which situations while minimizing the likelihood that any applications will be broken.

Here is an incomplete list of reasons a key may be unsupported:

  • Invalid or Inconsistent Components: A component of the key has an invalid value, or the mathematical relationship between two (or more) components required for a valid key does not hold.

  • The encoding of the key is invalid. Perhaps the key isn’t in the correct format; e.g. it may be Base64 (“PEM”) encoded, in which case the Base64 encoding needs to be undone first.

  • The encoding includes a versioning mechanism and that mechanism indicates that the key is encoded in a version of the encoding that isn’t supported. This might happen for multi-prime RSA keys (keys with more than two private prime factors), which aren’t supported, for example.

  • Too small or too Large: One of the primary components of the key is too small or two large. Too-small keys are rejected for security reasons. Some unnecessarily large keys are rejected for performance reasons.

  • Wrong algorithm: The key is not valid for the algorithm in which it was being used.

  • Unexpected errors: Report this as a bug.

Implementations

The value returned from ::description()

Trait Implementations

Returns a copy of the value. Read more

Performs copy-assignment from source. Read more

Formats the value using the given formatter. Read more

Formats the value using the given formatter. Read more

👎 Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

👎 Deprecated since 1.42.0:

use the Display impl or to_string()

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

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

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

Performs the conversion.

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

Returns the argument unchanged.

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

The resulting type after obtaining ownership.

Creates owned data from borrowed data, usually by cloning. Read more

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

Uses borrowed data to replace owned data, usually by cloning. Read more

Converts the given value to a String. Read more

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.