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

//! Implementations of DekuRead and DekuWrite for tuples of length 1 to 11

use crate::writer::Writer;

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

use crate::{DekuError, DekuReader, DekuWriter};

// Trait to help us build intermediate tuples while DekuRead'ing each element
// from the tuple
trait Append<T> {
    type NewType;

    fn append(self, new: T) -> Self::NewType;
}

// Allow us to append an element of type T to a unit for the purpose
// of building a tuple
// Creates a tuple of length 1
impl<T> Append<T> for () {
    type NewType = (T,);

    fn append(self, new: T) -> Self::NewType {
        (new,)
    }
}

macro_rules! ImplDekuTupleTraits {
    ( $($T:ident,)+ ) => {
        impl<$($T,)+ U> Append<U> for ($($T,)+) {
            type NewType = ($($T,)+ U,);

            #[allow(non_snake_case)]
            fn append(self, new: U) -> Self::NewType {
                let ($($T,)+) = self;
                ($($T,)+ new,)
            }
        }

        impl<'a, Ctx: Copy, $($T:DekuReader<'a, Ctx>+Sized),+> DekuReader<'a, Ctx> for ($($T,)+)
        {
            fn from_reader_with_ctx<R: Read + Seek>(
                reader: &mut crate::reader::Reader<R>,
                ctx: Ctx,
            ) -> Result<Self, DekuError>
            where
                Self: Sized,
            {
                let tuple = ();
                $(
                    let val = <$T>::from_reader_with_ctx(reader, ctx)?;
                    let tuple = tuple.append(val);
                )+
                Ok(tuple)
            }
        }

        impl<Ctx: Copy, $($T:DekuWriter<Ctx>),+> DekuWriter<Ctx> for ($($T,)+)
        {
            #[allow(non_snake_case)]
            fn to_writer<W: Write + Seek>(&self, writer: &mut Writer<W>, ctx: Ctx) -> Result<(), DekuError> {
                let ($(ref $T,)+) = *self;
                $(
                    $T.to_writer(writer, ctx)?;
                )+
                Ok(())
            }
        }
    };
}

ImplDekuTupleTraits! { A, }
ImplDekuTupleTraits! { A, B, }
ImplDekuTupleTraits! { A, B, C, }
ImplDekuTupleTraits! { A, B, C, D, }
ImplDekuTupleTraits! { A, B, C, D, E, }
ImplDekuTupleTraits! { A, B, C, D, E, F, }
ImplDekuTupleTraits! { A, B, C, D, E, F, G, }
ImplDekuTupleTraits! { A, B, C, D, E, F, G, H, }
ImplDekuTupleTraits! { A, B, C, D, E, F, G, H, I, }
ImplDekuTupleTraits! { A, B, C, D, E, F, G, H, I, J, }
ImplDekuTupleTraits! { A, B, C, D, E, F, G, H, I, J, K, }

macro_rules! ImplDekuSizeTuple {
    ( $($T:ident,)+ ) => {
        impl<$($T: crate::DekuSize),+> crate::DekuSize for ($($T,)+) {
            const SIZE_BITS: usize = 0 $(+ $T::SIZE_BITS)+;
        }
    };
}

ImplDekuSizeTuple! { A, }
ImplDekuSizeTuple! { A, B, }
ImplDekuSizeTuple! { A, B, C, }
ImplDekuSizeTuple! { A, B, C, D, }
ImplDekuSizeTuple! { A, B, C, D, E, }
ImplDekuSizeTuple! { A, B, C, D, E, F, }
ImplDekuSizeTuple! { A, B, C, D, E, F, G, }
ImplDekuSizeTuple! { A, B, C, D, E, F, G, H, }
ImplDekuSizeTuple! { A, B, C, D, E, F, G, H, I, }
ImplDekuSizeTuple! { A, B, C, D, E, F, G, H, I, J, }
ImplDekuSizeTuple! { A, B, C, D, E, F, G, H, I, J, K, }

#[cfg(all(feature = "alloc", feature = "std"))]
#[cfg(test)]
mod tests {
    use rstest::rstest;

    use super::*;
    use crate::native_endian;

    #[rstest(input, expected,
        case::length_1((native_endian!(0xdeadbeef_u32),), vec![0xef, 0xbe, 0xad, 0xde]),
        case::length_2((true, native_endian!(0x829824_u32)), vec![1, 0x24, 0x98, 0x82, 0]),
        case::length_11((0u8, 1u8, 2u8, 3u8, 4u8, 5u8, 6u8, 7u8, 8u8, 9u8, 10u8), vec![0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10])
    )]
    fn test_tuple_write<T>(input: T, expected: Vec<u8>)
    where
        T: DekuWriter,
    {
        use std::io::Cursor;

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