devela 0.28.0

A development substrate of coherence.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58

// devela::data::codec::crypto::error
//
//! Defines [`CryptoError`].
//

use crate::{_impl_init, impl_trait};

#[doc = crate::_tags!(crypto error)]
/// An error from a cryptographic codec or primitive.
#[doc = crate::_doc_meta!{location("data/codec/crypto")}]
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)]
#[non_exhaustive]
pub enum CryptoError {
    /// The key length is invalid for the selected algorithm.
    InvalidKeyLength,

    /// The input length is invalid for the selected operation.
    InvalidLength,

    /// The input length exceeds the algorithm's supported range.
    LengthOverflow,

    /// A non-length operation parameter is invalid for the selected operation.
    InvalidParameter,

    /// Authentication, verification, or integrity checking failed.
    VerificationFailed,
}
impl CryptoError {
    /// Returns `true` for [`InvalidKeyLength`][CryptoError::InvalidKeyLength].
    pub const fn is_invalid_key_length(self) -> bool {
        matches!(self, Self::InvalidKeyLength)
    }
    /// Returns `true` for [`InvalidLength`][CryptoError::InvalidLength].
    pub const fn is_invalid_length(self) -> bool {
        matches!(self, Self::InvalidLength)
    }
    /// Returns `true` for [`InvalidParameter`][CryptoError::InvalidParameter].
    pub const fn is_invalid_parameter(self) -> bool {
        matches!(self, Self::InvalidParameter)
    }
    /// Returns `true` for [`LengthOverflow`][CryptoError::LengthOverflow].
    pub const fn is_length_overflow(self) -> bool {
        matches!(self, Self::LengthOverflow)
    }
    /// Returns `true` for [`VerificationFailed`][CryptoError::VerificationFailed].
    pub const fn is_verification_failed(self) -> bool {
        matches!(self, Self::VerificationFailed)
    }
}
_impl_init![Self::LengthOverflow => CryptoError];
impl_trait![fmt::Display+Error for CryptoError |self, f| match self {
    Self::InvalidKeyLength => f.write_str("invalid cryptographic key length"),
    Self::InvalidLength => f.write_str("invalid cryptographic input length"),
    Self::InvalidParameter => f.write_str("invalid cryptographic operation parameter"),
    Self::LengthOverflow => f.write_str("cryptographic input length overflow"),
    Self::VerificationFailed => f.write_str("cryptographic verification failed"),
}];