ssh_encoding/
error.rs

1//! Error types.
2
3use crate::LabelError;
4use core::fmt;
5
6/// Result type with `ssh-encoding` crate's [`Error`] as the error type.
7pub type Result<T> = core::result::Result<T, Error>;
8
9/// Error type.
10#[derive(Clone, Debug, Eq, PartialEq)]
11#[non_exhaustive]
12pub enum Error {
13    /// Base64-related errors.
14    #[cfg(feature = "base64")]
15    Base64(base64::Error),
16
17    /// Character encoding-related errors.
18    CharacterEncoding,
19
20    /// Invalid label.
21    Label(LabelError),
22
23    /// Invalid length.
24    Length,
25
26    /// Overflow errors.
27    Overflow,
28
29    /// PEM encoding errors.
30    #[cfg(feature = "pem")]
31    Pem(pem::Error),
32
33    /// Unexpected trailing data at end of message.
34    TrailingData {
35        /// Number of bytes of remaining data at end of message.
36        remaining: usize,
37    },
38}
39
40impl fmt::Display for Error {
41    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
42        match self {
43            #[cfg(feature = "base64")]
44            Error::Base64(err) => write!(f, "Base64 encoding error: {err}"),
45            Error::CharacterEncoding => write!(f, "character encoding invalid"),
46            Error::Label(err) => write!(f, "{}", err),
47            Error::Length => write!(f, "length invalid"),
48            Error::Overflow => write!(f, "internal overflow error"),
49            #[cfg(feature = "pem")]
50            Error::Pem(err) => write!(f, "{err}"),
51            Error::TrailingData { remaining } => write!(
52                f,
53                "unexpected trailing data at end of message ({remaining} bytes)",
54            ),
55        }
56    }
57}
58
59impl From<LabelError> for Error {
60    fn from(err: LabelError) -> Error {
61        Error::Label(err)
62    }
63}
64
65impl From<core::num::TryFromIntError> for Error {
66    fn from(_: core::num::TryFromIntError) -> Error {
67        Error::Overflow
68    }
69}
70
71impl From<core::str::Utf8Error> for Error {
72    fn from(_: core::str::Utf8Error) -> Error {
73        Error::CharacterEncoding
74    }
75}
76
77#[cfg(feature = "alloc")]
78impl From<alloc::string::FromUtf8Error> for Error {
79    fn from(_: alloc::string::FromUtf8Error) -> Error {
80        Error::CharacterEncoding
81    }
82}
83
84#[cfg(feature = "base64")]
85impl From<base64::Error> for Error {
86    fn from(err: base64::Error) -> Error {
87        Error::Base64(err)
88    }
89}
90
91#[cfg(feature = "base64")]
92impl From<base64::InvalidLengthError> for Error {
93    fn from(_: base64::InvalidLengthError) -> Error {
94        Error::Length
95    }
96}
97
98#[cfg(feature = "pem")]
99impl From<pem::Error> for Error {
100    fn from(err: pem::Error) -> Error {
101        Error::Pem(err)
102    }
103}
104
105#[cfg(feature = "std")]
106impl std::error::Error for Error {
107    fn source(&self) -> Option<&(dyn std::error::Error + 'static)> {
108        match self {
109            #[cfg(feature = "base64")]
110            Self::Base64(err) => Some(err),
111            #[cfg(feature = "pem")]
112            Self::Pem(err) => Some(err),
113            _ => None,
114        }
115    }
116}
ssh_encoding/error.rs

ssh_encoding/
error.rs
