Enum ssh_key::Error

#[non_exhaustive]
pub enum Error {
    AlgorithmUnknown,
    AlgorithmUnsupported {
        algorithm: Algorithm,
    },
    CertificateFieldInvalid(Field),
    CertificateValidation,
    Crypto,
    Decrypted,
    Ecdsa(Error),
    Encoding(Error),
    Encrypted,
    FormatEncoding,
    Io(ErrorKind),
    Namespace,
    PublicKey,
    Time,
    TrailingData {
        remaining: usize,
    },
    Version {
        number: u32,
    },
}

Error type.

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.

AlgorithmUnknown

Unknown algorithm.

This is returned when an algorithm is completely unknown to this crate.

AlgorithmUnsupported

Unsupported algorithm.

This is typically returned when an algorithm is recognized, but the relevant crate features to support it haven’t been enabled.

It may also be returned in the event an algorithm is inappropriate for a given usage pattern or context.

Fields

algorithm: Algorithm

Algorithm identifier.

CertificateFieldInvalid(Field)

Available on crate feature alloc only.

Certificate field is invalid or already set.

CertificateValidation

Certificate validation failed.

Crypto

Cryptographic errors.

Decrypted

Cannot perform operation on decrypted private key.

Ecdsa(Error)

Available on crate feature ecdsa only.

ECDSA key encoding errors.

Encoding(Error)

Encoding errors.

Encrypted

Cannot perform operation on encrypted private key.

FormatEncoding

Other format encoding errors.

Io(ErrorKind)

Available on crate feature std only.

Input/output errors.

Namespace

Namespace invalid.

PublicKey

Public key is incorrect.

Time

Invalid timestamp (e.g. in a certificate)

TrailingData

Unexpected trailing data at end of message.

Fields

remaining: usize

Number of bytes of remaining data at end of message.

Version

Unsupported version.

Fields

number: u32

Version number.

Trait Implementations

impl Clone for Error

fn clone(&self) -> Error

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Error

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

Formats the value using the given formatter.

impl Display for Error

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

Formats the value using the given formatter.

impl Error for Error

Available on crate feature std only.

fn source(&self) -> Option<&(dyn Error + 'static)>

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

Available on crate feature std only.

fn from(err: Error) -> Error

Converts to this type from the input type.

impl From<Error> for Error

Available on crate feature ecdsa only.

fn from(err: Error) -> Error

Converts to this type from the input type.

impl From<Error> for Error

Available on crate feature rsa only.

fn from(_: Error) -> Error

Converts to this type from the input type.

impl From<Error> for Error

fn from(err: Error) -> Error

Converts to this type from the input type.

impl From<Error> for Error

Available on crate feature std only.

fn from(err: Error) -> Error

Converts to this type from the input type.

impl From<Error> for Error

fn from(_: Error) -> Error

Converts to this type from the input type.

impl From<Error> for Error

fn from(err: Error) -> Error

Converts to this type from the input type.

impl From<Error> for Error

Available on crate feature std only.

fn from(err: Error) -> Error

Converts to this type from the input type.

impl From<Error> for Error

fn from(err: Error) -> Error

Converts to this type from the input type.

impl From<FromUtf8Error> for Error

Available on crate feature alloc only.

fn from(err: FromUtf8Error) -> Error

Converts to this type from the input type.

impl From<LabelError> for Error

fn from(err: LabelError) -> Error

Converts to this type from the input type.

impl From<SystemTimeError> for Error

Available on crate feature std only.

fn from(_: SystemTimeError) -> Error

Converts to this type from the input type.

impl From<TryFromSliceError> for Error

fn from(_: TryFromSliceError) -> Error

Converts to this type from the input type.

impl From<Utf8Error> for Error

fn from(err: Utf8Error) -> Error

Converts to this type from the input type.

impl PartialEq for Error

fn eq(&self, other: &Error) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Error

impl StructuralPartialEq for Error