crafter 0.3.0

Packet-level network interaction for Rust tools and agents.
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
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160

//! MAC address parsing and formatting.

use core::fmt;
use core::str::FromStr;

use crate::error::CrafterError;

/// A six-octet Ethernet MAC address.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, PartialOrd, Ord)]
pub struct MacAddr([u8; 6]);

impl MacAddr {
    /// The all-zero MAC address.
    pub const ZERO: Self = Self([0, 0, 0, 0, 0, 0]);

    /// The broadcast MAC address.
    pub const BROADCAST: Self = Self([0xff, 0xff, 0xff, 0xff, 0xff, 0xff]);

    /// Create a MAC address from six octets.
    pub const fn new(octets: [u8; 6]) -> Self {
        Self(octets)
    }

    /// Return the six address octets.
    pub const fn octets(self) -> [u8; 6] {
        self.0
    }

    /// Return true when this address is the broadcast address.
    pub const fn is_broadcast(self) -> bool {
        self.0[0] == 0xff
            && self.0[1] == 0xff
            && self.0[2] == 0xff
            && self.0[3] == 0xff
            && self.0[4] == 0xff
            && self.0[5] == 0xff
    }

    /// Return true when the address is multicast or broadcast.
    pub const fn is_multicast(self) -> bool {
        self.0[0] & 1 == 1
    }
}

impl From<[u8; 6]> for MacAddr {
    fn from(value: [u8; 6]) -> Self {
        Self(value)
    }
}

impl From<MacAddr> for [u8; 6] {
    fn from(value: MacAddr) -> Self {
        value.0
    }
}

impl AsRef<[u8; 6]> for MacAddr {
    fn as_ref(&self) -> &[u8; 6] {
        &self.0
    }
}

impl fmt::Display for MacAddr {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(
            f,
            "{:02x}:{:02x}:{:02x}:{:02x}:{:02x}:{:02x}",
            self.0[0], self.0[1], self.0[2], self.0[3], self.0[4], self.0[5]
        )
    }
}

impl FromStr for MacAddr {
    type Err = CrafterError;

    fn from_str(input: &str) -> Result<Self, Self::Err> {
        let separator = if input.contains(':') {
            ':'
        } else if input.contains('-') {
            '-'
        } else {
            return Err(CrafterError::invalid_mac_address(
                input,
                "expected ':' or '-' separators",
            ));
        };

        let mut octets = [0u8; 6];
        let mut count = 0usize;
        for part in input.split(separator) {
            if count == octets.len() {
                return Err(CrafterError::invalid_mac_address(
                    input,
                    "expected exactly six octets",
                ));
            }
            if part.len() != 2 {
                return Err(CrafterError::invalid_mac_address(
                    input,
                    "each octet must contain two hex digits",
                ));
            }
            octets[count] = u8::from_str_radix(part, 16).map_err(|_| {
                CrafterError::invalid_mac_address(input, "octet contains non-hex digits")
            })?;
            count += 1;
        }

        if count != octets.len() {
            return Err(CrafterError::invalid_mac_address(
                input,
                "expected exactly six octets",
            ));
        }

        Ok(Self(octets))
    }
}

#[cfg(test)]
mod field_primitives {
    use super::MacAddr;

    #[test]
    fn parses_colon_mac_address() {
        let mac: MacAddr = "02:00:5e:10:00:01".parse().unwrap();

        assert_eq!(mac.octets(), [0x02, 0x00, 0x5e, 0x10, 0x00, 0x01]);
        assert_eq!(mac.to_string(), "02:00:5e:10:00:01");
    }

    #[test]
    fn parses_hyphen_mac_address() {
        let mac: MacAddr = "AA-BB-CC-DD-EE-FF".parse().unwrap();

        assert_eq!(mac.octets(), [0xaa, 0xbb, 0xcc, 0xdd, 0xee, 0xff]);
        assert_eq!(mac.to_string(), "aa:bb:cc:dd:ee:ff");
    }

    #[test]
    fn rejects_invalid_octet_count() {
        let err = "00:11:22:33:44".parse::<MacAddr>().unwrap_err();

        assert!(err.to_string().contains("six octets"));
    }

    #[test]
    fn rejects_invalid_hex() {
        let err = "00:11:22:33:44:xx".parse::<MacAddr>().unwrap_err();

        assert!(err.to_string().contains("non-hex"));
    }

    #[test]
    fn detects_broadcast_and_multicast_addresses() {
        assert!(MacAddr::BROADCAST.is_broadcast());
        assert!(MacAddr::BROADCAST.is_multicast());
        assert!(!MacAddr::ZERO.is_multicast());
    }
}