Struct ring::error::KeyRejected
source · [−]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
sourceimpl KeyRejected
impl KeyRejected
sourcepub fn description_(&self) -> &'static str
pub fn description_(&self) -> &'static str
The value returned from
Trait Implementations
sourceimpl Clone for KeyRejected
impl Clone for KeyRejected
sourcefn clone(&self) -> KeyRejected
fn clone(&self) -> KeyRejected
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl Debug for KeyRejected
impl Debug for KeyRejected
sourceimpl Display for KeyRejected
impl Display for KeyRejected
sourceimpl From<KeyRejected> for Unspecified
impl From<KeyRejected> for Unspecified
sourcefn from(_: KeyRejected) -> Self
fn from(_: KeyRejected) -> Self
Performs the conversion.
impl Copy for KeyRejected
Auto Trait Implementations
impl RefUnwindSafe for KeyRejected
impl Send for KeyRejected
impl Sync for KeyRejected
impl Unpin for KeyRejected
impl UnwindSafe for KeyRejected
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more