Struct ring::error::KeyRejected[−][src]

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

impl KeyRejected[src]

pub fn description_(&self) -> &'static str[src]

The value returned from ::description()

Trait Implementations

impl Clone for KeyRejected[src]

fn clone(&self) -> KeyRejected[src]

Returns a copy of the value. Read more

fn clone_from(&mut self, source: &Self)1.0.0[src]

Performs copy-assignment from source. Read more

impl Debug for KeyRejected[src]

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

Formats the value using the given formatter. Read more

impl Display for KeyRejected[src]

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

Formats the value using the given formatter. Read more

impl From<KeyRejected> for Unspecified[src]

fn from(_: KeyRejected) -> Self[src]

Performs the conversion.

impl Copy for KeyRejected[src]

Auto Trait Implementations

impl Send for KeyRejected

impl Sync for KeyRejected

impl Unpin for KeyRejected

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized, [src]

pub fn type_id(&self) -> TypeId[src]

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T where
    T: ?Sized, [src]

pub fn borrow(&self) -> &T[src]

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T where
    T: ?Sized, [src]

pub fn borrow_mut(&mut self) -> &mut T[src]

Mutably borrows from an owned value. Read more

impl<T> From<T> for T[src]

pub fn from(t: T) -> T[src]

Performs the conversion.

impl<T, U> Into<U> for T where
    U: From<T>, [src]

pub fn into(self) -> U[src]

Performs the conversion.

impl<T> ToOwned for T where
    T: Clone, [src]

type Owned = T

The resulting type after obtaining ownership.

pub fn to_owned(&self) -> T[src]

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

pub fn clone_into(&self, target: &mut T)[src]

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

recently added

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

impl<T> ToString for T where
    T: Display + ?Sized, [src]

pub default fn to_string(&self) -> String[src]

Converts the given value to a String. Read more

impl<T, U> TryFrom<U> for T where
    U: Into<T>, [src]

type Error = Infallible

The type returned in the event of a conversion error.

pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>[src]

Performs the conversion.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, [src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>[src]

Performs the conversion.