ssh_cipher/
error.rs

1//! Error types.
2
3use crate::Cipher;
4use core::fmt;
5
6/// Result type with `ssh-cipher` 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    /// Cryptographic errors.
14    Crypto,
15
16    /// Invalid key size.
17    KeySize,
18
19    /// Invalid initialization vector / nonce size.
20    IvSize,
21
22    /// Invalid AEAD tag size.
23    TagSize,
24
25    /// Unsupported cipher.
26    UnsupportedCipher(Cipher),
27}
28
29impl fmt::Display for Error {
30    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
31        match self {
32            Error::Crypto => write!(f, "cryptographic error"),
33            Error::KeySize => write!(f, "invalid key size"),
34            Error::IvSize => write!(f, "invalid initialization vector size"),
35            Error::TagSize => write!(f, "invalid AEAD tag size"),
36            Error::UnsupportedCipher(cipher) => write!(f, "unsupported cipher: {}", cipher),
37        }
38    }
39}
40
41#[cfg(feature = "std")]
42impl std::error::Error for Error {}
ssh_cipher/error.rs

ssh_cipher/
error.rs
