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
140
141
142
143
144
145

use alloc::ffi::CString;

use alloc::vec::Vec;
use no_std_io::io::{Read, Seek, Write};

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

impl<Ctx: Copy> DekuWriter<Ctx> for CString
where
    u8: DekuWriter<Ctx>,
{
    fn to_writer<W: Write + Seek>(
        &self,
        writer: &mut Writer<W>,
        ctx: Ctx,
    ) -> Result<(), DekuError> {
        let bytes = self.as_bytes_with_nul();
        bytes.to_writer(writer, ctx)
    }
}

impl DekuReader<'_> for CString {
    fn from_reader_with_ctx<R: Read + Seek>(
        reader: &mut Reader<R>,
        _: (),
    ) -> Result<Self, DekuError> {
        let bytes =
            Vec::<u8>::from_reader_with_ctx(reader, (Limit::from(|b: &u8| *b == 0x00), ()))?;

        let value = CString::from_vec_with_nul(bytes).map_err(|e| {
            crate::deku_error!(
                DekuError::Parse,
                "Failed to convert Vec to CString",
                "{}",
                e
            )
        })?;

        Ok(value)
    }
}

impl<'a> DekuReader<'a, ByteSize> for CString
where
    u8: DekuReader<'a>,
{
    fn from_reader_with_ctx<R: Read + Seek>(
        reader: &mut Reader<R>,
        byte_size: ByteSize,
    ) -> Result<Self, DekuError> {
        let bytes = Vec::from_reader_with_ctx(reader, (Limit::from(byte_size.0), ()))?;

        let value = CString::from_vec_with_nul(bytes).map_err(|e| {
            crate::deku_error!(
                DekuError::Parse,
                "Failed to convert Vec to CString",
                "{}",
                e
            )
        })?;

        Ok(value)
    }
}

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

    use crate::reader::Reader;

    use super::*;

    #[rstest(input, len, expected, expected_rest,
        case(
            b"test\0",
            Some(5),
            CString::new("test").unwrap(),
            &[],
        ),
        case(
            b"test\0",
            None,
            CString::new("test").unwrap(),
            &[],
        ),
        case(
            b"test\0a",
            Some(5),
            CString::new("test").unwrap(),
            b"a",
        ),
        case(
            b"test\0a",
            None,
            CString::new("test").unwrap(),
            b"a",
        ),

        #[should_panic(expected = "Failed to convert Vec to CString")]
        case(
            b"test",
            Some(4),
            CString::new("test").unwrap(),
            b"a",
        ),

        #[should_panic(expected = "Incomplete(NeedSize { bits: 8 })")]
        case(b"test", Some(5), CString::new("test").unwrap(), &[]),

        #[should_panic(expected = "Incomplete(NeedSize { bits: 8 })")]
        case(b"test", None, CString::new("test").unwrap(), &[]),
    )]
    fn test_cstring_count(
        input: &[u8],
        len: Option<usize>,
        expected: CString,
        expected_rest: &[u8],
    ) {
        let mut cursor = Cursor::new(input);
        let mut reader = Reader::new(&mut cursor);
        let res_read = if let Some(len) = len {
            CString::from_reader_with_ctx(&mut reader, ByteSize(len)).unwrap()
        } else {
            CString::from_reader_with_ctx(&mut reader, ()).unwrap()
        };
        assert_eq!(expected, res_read);
        let mut buf = vec![];
        cursor.read_to_end(&mut buf).unwrap();
        assert_eq!(expected_rest, buf);

        let mut writer = Writer::new(Cursor::new(vec![]));
        res_read.to_writer(&mut writer, ()).unwrap();
        assert_eq!(
            vec![b't', b'e', b's', b't', b'\0'],
            writer.inner.into_inner()
        );
    }
}