deku 0.20.3

bit level serialization/deserialization proc-macro for structs
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

use core::net::{IpAddr, Ipv4Addr, Ipv6Addr};

use no_std_io::io::{Read, Seek, Write};

use crate::reader::Reader;
use crate::writer::Writer;
use crate::{DekuError, DekuReader, DekuWriter};

impl<'a, Ctx> DekuReader<'a, Ctx> for Ipv4Addr
where
    u32: DekuReader<'a, Ctx>,
{
    fn from_reader_with_ctx<R: Read + Seek>(
        reader: &mut Reader<R>,
        inner_ctx: Ctx,
    ) -> Result<Self, DekuError> {
        let ip = u32::from_reader_with_ctx(reader, inner_ctx)?;
        Ok(ip.into())
    }
}

impl<Ctx> DekuWriter<Ctx> for Ipv4Addr
where
    u32: DekuWriter<Ctx>,
{
    fn to_writer<W: Write + Seek>(
        &self,
        writer: &mut Writer<W>,
        ctx: Ctx,
    ) -> Result<(), DekuError> {
        let ip: u32 = (*self).into();
        ip.to_writer(writer, ctx)
    }
}

impl<'a, Ctx> DekuReader<'a, Ctx> for Ipv6Addr
where
    u128: DekuReader<'a, Ctx>,
{
    fn from_reader_with_ctx<R: Read + Seek>(
        reader: &mut Reader<R>,
        inner_ctx: Ctx,
    ) -> Result<Self, DekuError> {
        let ip = u128::from_reader_with_ctx(reader, inner_ctx)?;
        Ok(ip.into())
    }
}

impl<Ctx> DekuWriter<Ctx> for Ipv6Addr
where
    u128: DekuWriter<Ctx>,
{
    fn to_writer<W: Write + Seek>(
        &self,
        writer: &mut Writer<W>,
        ctx: Ctx,
    ) -> Result<(), DekuError> {
        let ip: u128 = (*self).into();
        ip.to_writer(writer, ctx)
    }
}

impl<Ctx> DekuWriter<Ctx> for IpAddr
where
    Ipv6Addr: DekuWriter<Ctx>,
    Ipv4Addr: DekuWriter<Ctx>,
{
    fn to_writer<W: Write + Seek>(
        &self,
        writer: &mut Writer<W>,
        ctx: Ctx,
    ) -> Result<(), DekuError> {
        match self {
            IpAddr::V4(ipv4) => ipv4.to_writer(writer, ctx),
            IpAddr::V6(ipv6) => ipv6.to_writer(writer, ctx),
        }
    }
}

#[cfg(feature = "alloc")]
#[cfg(test)]
mod tests {
    use alloc::vec;
    use no_std_io::io::Cursor;
    use rstest::rstest;

    use super::*;
    use crate::{ctx::Endian, reader::Reader};

    #[rstest(input, endian, expected,
        case::normal_le([237, 160, 254, 145].as_ref(), Endian::Little, Ipv4Addr::new(145, 254, 160, 237)),
        case::normal_be([145, 254, 160, 237].as_ref(), Endian::Big, Ipv4Addr::new(145, 254, 160, 237)),
    )]
    fn test_ipv4(input: &[u8], endian: Endian, expected: Ipv4Addr) {
        let mut cursor = Cursor::new(input);
        let mut reader = Reader::new(&mut cursor);
        let res_read = Ipv4Addr::from_reader_with_ctx(&mut reader, endian).unwrap();
        assert_eq!(expected, res_read);

        let mut writer = Writer::new(Cursor::new(vec![]));
        res_read.to_writer(&mut writer, endian).unwrap();
        assert_eq!(input.to_vec(), writer.inner.into_inner());
    }

    #[rstest(input, endian, expected,
        case::normal_le([0xFF, 0x02, 0x0A, 0xC0, 0xFF, 0xFF, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00].as_ref(), Endian::Little, Ipv6Addr::new(0, 0, 0, 0, 0, 0xffff, 0xc00a, 0x02ff)),
        case::normal_be([0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0xFF, 0xFF, 0xC0, 0x0A, 0x02, 0xFF].as_ref(), Endian::Big, Ipv6Addr::new(0, 0, 0, 0, 0, 0xffff, 0xc00a, 0x02ff)),
    )]
    fn test_ipv6(input: &[u8], endian: Endian, expected: Ipv6Addr) {
        let mut cursor = Cursor::new(input);
        let mut reader = Reader::new(&mut cursor);
        let res_read = Ipv6Addr::from_reader_with_ctx(&mut reader, endian).unwrap();
        assert_eq!(expected, res_read);

        let mut writer = Writer::new(Cursor::new(vec![]));
        res_read.to_writer(&mut writer, endian).unwrap();
        assert_eq!(input.to_vec(), writer.inner.into_inner());
    }

    #[test]
    fn test_ip_addr_write() {
        let ip_addr = IpAddr::V4(Ipv4Addr::new(145, 254, 160, 237));

        let mut writer = Writer::new(Cursor::new(vec![]));
        ip_addr.to_writer(&mut writer, Endian::Little).unwrap();
        assert_eq!(vec![237, 160, 254, 145], writer.inner.into_inner());

        let ip_addr = IpAddr::V6(Ipv6Addr::new(0, 0, 0, 0, 0, 0xffff, 0xc00a, 0x02ff));
        let mut writer = Writer::new(Cursor::new(vec![]));
        ip_addr.to_writer(&mut writer, Endian::Little).unwrap();
        assert_eq!(
            vec![
                0xff, 0x02, 0x0a, 0xc0, 0xff, 0xff, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
                0x00, 0x00
            ],
            writer.inner.into_inner()
        );
    }
}