etherparse/err/ipv6/
header_error.rs

1/// Error when decoding the IPv6 header.
2#[derive(Clone, Debug, Eq, PartialEq, Hash)]
3pub enum HeaderError {
4    /// Error when the IPv6 header version field is not equal to 6.
5    UnexpectedVersion {
6        /// The unexpected version number in the IPv6 header.
7        version_number: u8,
8    },
9}
10
11impl core::fmt::Display for HeaderError {
12    fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
13        use HeaderError::*;
14        match self {
15            UnexpectedVersion { version_number } => write!(f, "IPv6 Header Error: Encountered '{version_number}' as IP version number in the IPv6 header (must be '6' in an IPv6 header)."),
16        }
17    }
18}
19
20impl core::error::Error for HeaderError {
21    fn source(&self) -> Option<&(dyn core::error::Error + 'static)> {
22        None
23    }
24}
25
26#[cfg(test)]
27mod tests {
28    use super::{HeaderError::*, *};
29    use alloc::format;
30    use std::{
31        collections::hash_map::DefaultHasher,
32        error::Error,
33        hash::{Hash, Hasher},
34    };
35
36    #[test]
37    fn debug() {
38        assert_eq!(
39            "UnexpectedVersion { version_number: 1 }",
40            format!("{:?}", UnexpectedVersion { version_number: 1 })
41        );
42    }
43
44    #[test]
45    fn clone_eq_hash() {
46        let err = HeaderError::UnexpectedVersion { version_number: 6 };
47        assert_eq!(err, err.clone());
48        let hash_a = {
49            let mut hasher = DefaultHasher::new();
50            err.hash(&mut hasher);
51            hasher.finish()
52        };
53        let hash_b = {
54            let mut hasher = DefaultHasher::new();
55            err.clone().hash(&mut hasher);
56            hasher.finish()
57        };
58        assert_eq!(hash_a, hash_b);
59    }
60
61    #[test]
62    fn fmt() {
63        assert_eq!(
64            "IPv6 Header Error: Encountered '1' as IP version number in the IPv6 header (must be '6' in an IPv6 header).",
65            format!("{}", UnexpectedVersion{ version_number: 1 })
66        );
67    }
68
69    #[cfg(feature = "std")]
70    #[test]
71    fn source() {
72        let values = [UnexpectedVersion { version_number: 0 }];
73        for v in values {
74            assert!(v.source().is_none());
75        }
76    }
77}