endi/
endian.rs

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
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
/// The endian of the data.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub enum Endian {
    /// Little endian.
    Little,
    /// Big endian.
    Big,
}

/// Alias for [`Endian::Little`].
pub const LE: Endian = Endian::Little;
/// Alias for [`Endian::Big`].
pub const BE: Endian = Endian::Big;
/// Same as the return value of [`Endian::native`].
pub const NATIVE_ENDIAN: Endian = Endian::native();
/// Alias for [`Endian::Big`].
pub const NETWORK_ENDIAN: Endian = Endian::Big;

macro_rules! impl_read_method {
    ($type:ty, $method:ident, $size:literal) => {
        #[doc = concat!("Read a `", stringify!($type), "` from a byte slice.\n\n", "# Panics\n\n", "Panics if the slice is smaller than ", stringify!($size), " bytes.")]
        #[inline]
        pub fn $method(self, buf: &[u8]) -> $type {
            match self {
                Self::Little => <$type>::from_le_bytes(buf[..$size].try_into().unwrap()),
                Self::Big => <$type>::from_be_bytes(buf[..$size].try_into().unwrap()),
            }
        }
    };
}

macro_rules! impl_write_method {
    ($type:ty, $method:ident, $size:literal) => {
        #[doc = concat!("Write a `", stringify!($type), "` into a mutable byte slice.\n\n", "# Panics\n\n", "Panics if the slice is smaller than ", stringify!($size), " bytes.")]
        #[inline]
        pub fn $method(self, buf: &mut [u8], n: $type) {
            match self {
                Self::Little => buf[..$size].copy_from_slice(&n.to_le_bytes()),
                Self::Big => buf[..$size].copy_from_slice(&n.to_be_bytes()),
            }
        }
    };
}

impl Endian {
    /// The native endian.
    #[inline]
    pub const fn native() -> Self {
        #[cfg(target_endian = "little")]
        {
            Self::Little
        }
        #[cfg(target_endian = "big")]
        {
            Self::Big
        }
    }

    // Reading.

    // Unsigned integers
    impl_read_method!(u8, read_u8, 1);
    impl_read_method!(u16, read_u16, 2);
    impl_read_method!(u32, read_u32, 4);
    impl_read_method!(u64, read_u64, 8);
    impl_read_method!(u128, read_u128, 16);

    // Signed integers
    impl_read_method!(i8, read_i8, 1);
    impl_read_method!(i16, read_i16, 2);
    impl_read_method!(i32, read_i32, 4);
    impl_read_method!(i64, read_i64, 8);
    impl_read_method!(i128, read_i128, 16);

    // Floating point numbers
    impl_read_method!(f32, read_f32, 4);
    impl_read_method!(f64, read_f64, 8);

    // Writing.

    // Unsigned integers
    impl_write_method!(u8, write_u8, 1);
    impl_write_method!(u16, write_u16, 2);
    impl_write_method!(u32, write_u32, 4);
    impl_write_method!(u64, write_u64, 8);
    impl_write_method!(u128, write_u128, 16);

    // Signed integers
    impl_write_method!(i8, write_i8, 1);
    impl_write_method!(i16, write_i16, 2);
    impl_write_method!(i32, write_i32, 4);
    impl_write_method!(i64, write_i64, 8);
    impl_write_method!(i128, write_i128, 16);

    // Floating point numbers
    impl_write_method!(f32, write_f32, 4);
    impl_write_method!(f64, write_f64, 8);
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn u8() {
        let buf = [0x01];
        assert_eq!(Endian::Little.read_u8(&buf), 0x01);
        assert_eq!(Endian::Big.read_u8(&buf), 0x01);
        let mut buf = [0x00];
        Endian::Little.write_u8(&mut buf, 0x01);
        assert_eq!(buf, [0x01]);
        Endian::Big.write_u8(&mut buf, 0x01);
        assert_eq!(buf, [0x01]);
    }

    #[test]
    fn u16() {
        let buf = [0x01, 0x02];
        assert_eq!(Endian::Little.read_u16(&buf), 0x02_01);
        assert_eq!(Endian::Big.read_u16(&buf), 0x01_02);
        let mut buf = [0x00, 0x00];
        Endian::Little.write_u16(&mut buf, 0x01_02);
        assert_eq!(buf, [0x02, 0x01]);
        Endian::Big.write_u16(&mut buf, 0x01_02);
        assert_eq!(buf, [0x01, 0x02]);
    }

    #[test]
    fn u32() {
        let buf = [0x01, 0x02, 0x03, 0x04];
        assert_eq!(Endian::Little.read_u32(&buf), 0x04_03_02_01);
        assert_eq!(Endian::Big.read_u32(&buf), 0x01_02_03_04);
        let mut buf = [0x00, 0x00, 0x00, 0x00];
        Endian::Little.write_u32(&mut buf, 0x01_02_03_04);
        assert_eq!(buf, [0x04, 0x03, 0x02, 0x01]);
        Endian::Big.write_u32(&mut buf, 0x01_02_03_04);
        assert_eq!(buf, [0x01, 0x02, 0x03, 0x04]);
    }

    #[test]
    fn u64() {
        let buf = [0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07, 0x08];
        assert_eq!(Endian::Little.read_u64(&buf), 0x08_07_06_05_04_03_02_01);
        assert_eq!(Endian::Big.read_u64(&buf), 0x01_02_03_04_05_06_07_08);
        let mut buf = [0x00; 8];
        Endian::Little.write_u64(&mut buf, 0x01_02_03_04_05_06_07_08);
        assert_eq!(buf, [0x08, 0x07, 0x06, 0x05, 0x04, 0x03, 0x02, 0x01]);
        Endian::Big.write_u64(&mut buf, 0x01_02_03_04_05_06_07_08);
        assert_eq!(buf, [0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07, 0x08]);
    }

    #[test]
    fn u128() {
        let buf = [
            0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07, 0x08, 0x09, 0x0a, 0x0b, 0x0c, 0x0d, 0x0e,
            0x0f, 0x10,
        ];
        assert_eq!(
            Endian::Little.read_u128(&buf),
            0x10_0f_0e_0d_0c_0b_0a_09_08_07_06_05_04_03_02_01
        );
        assert_eq!(
            Endian::Big.read_u128(&buf),
            0x01_02_03_04_05_06_07_08_09_0a_0b_0c_0d_0e_0f_10
        );
        let mut buf = [0x00; 16];
        Endian::Little.write_u128(&mut buf, 0x01_02_03_04_05_06_07_08_09_0a_0b_0c_0d_0e_0f_10);
        assert_eq!(
            buf,
            [
                0x10, 0x0f, 0x0e, 0x0d, 0x0c, 0x0b, 0x0a, 0x09, 0x08, 0x07, 0x06, 0x05, 0x04, 0x03,
                0x02, 0x01
            ]
        );
        Endian::Big.write_u128(&mut buf, 0x01_02_03_04_05_06_07_08_09_0a_0b_0c_0d_0e_0f_10);
        assert_eq!(
            buf,
            [
                0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07, 0x08, 0x09, 0x0a, 0x0b, 0x0c, 0x0d, 0x0e,
                0x0f, 0x10
            ]
        );
    }

    #[test]
    fn i8() {
        let buf = [0x01];
        assert_eq!(Endian::Little.read_i8(&buf), 0x01);
        assert_eq!(Endian::Big.read_i8(&buf), 0x01);
        let mut buf = [0x00];
        Endian::Little.write_i8(&mut buf, 0x01);
        assert_eq!(buf, [0x01]);
        Endian::Big.write_i8(&mut buf, 0x01);
        assert_eq!(buf, [0x01]);
    }

    #[test]
    fn i16() {
        let buf = [0x01, 0x02];
        assert_eq!(Endian::Little.read_i16(&buf), 0x02_01);
        assert_eq!(Endian::Big.read_i16(&buf), 0x01_02);
        let mut buf = [0x00, 0x00];
        Endian::Little.write_i16(&mut buf, 0x01_02);
        assert_eq!(buf, [0x02, 0x01]);
        Endian::Big.write_i16(&mut buf, 0x01_02);
        assert_eq!(buf, [0x01, 0x02]);
    }

    #[test]
    fn i32() {
        let buf = [0x01, 0x02, 0x03, 0x04];
        assert_eq!(Endian::Little.read_i32(&buf), 0x04_03_02_01);
        assert_eq!(Endian::Big.read_i32(&buf), 0x01_02_03_04);
        let mut buf = [0x00, 0x00, 0x00, 0x00];
        Endian::Little.write_i32(&mut buf, 0x01_02_03_04);
        assert_eq!(buf, [0x04, 0x03, 0x02, 0x01]);
        Endian::Big.write_i32(&mut buf, 0x01_02_03_04);
        assert_eq!(buf, [0x01, 0x02, 0x03, 0x04]);
    }

    #[test]
    fn i64() {
        let buf = [0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07, 0x08];
        assert_eq!(Endian::Little.read_i64(&buf), 0x08_07_06_05_04_03_02_01);
        assert_eq!(Endian::Big.read_i64(&buf), 0x01_02_03_04_05_06_07_08);
        let mut buf = [0x00; 8];
        Endian::Little.write_i64(&mut buf, 0x01_02_03_04_05_06_07_08);
        assert_eq!(buf, [0x08, 0x07, 0x06, 0x05, 0x04, 0x03, 0x02, 0x01]);
        Endian::Big.write_i64(&mut buf, 0x01_02_03_04_05_06_07_08);
        assert_eq!(buf, [0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07, 0x08]);
    }

    #[test]
    fn f32() {
        let buf = [0x00, 0x00, 0x80, 0x3f];
        assert_eq!(Endian::Little.read_f32(&buf), 1.0);
        assert_eq!(Endian::Big.read_f32(&buf), 4.6006e-41);
        let mut buf = [0x00; 4];
        Endian::Little.write_f32(&mut buf, 1.0);
        assert_eq!(buf, [0x00, 0x00, 0x80, 0x3f]);
        Endian::Big.write_f32(&mut buf, 1.0);
        assert_eq!(buf, [0x3f, 0x80, 0x00, 0x00]);
    }

    #[test]
    fn f64() {
        let buf = [0x00, 0x00, 0x00, 0x00, 0x00, 0xf0, 0xbf, 0x3f];
        assert_eq!(Endian::Little.read_f64(&buf), 0.124755859375);
        assert_eq!(Endian::Big.read_f64(&buf), 7.7951696e-317);
        let mut buf = [0x00; 8];
        Endian::Little.write_f64(&mut buf, 0.124755859375);
        assert_eq!(buf, [0x00, 0x00, 0x00, 0x00, 0x00, 0xf0, 0xbf, 0x3f]);
        Endian::Big.write_f64(&mut buf, 1.0);
        assert_eq!(buf, [0x3f, 0xf0, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00]);
    }
}