byteorder-pack 0.1.0

A binary data reader and writer that is similar to Python's struct module
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

use std::io::{Result as IoResult, Write};

use byteorder::{BigEndian, ByteOrder, LittleEndian, WriteBytesExt};

/// Write a value into a [`Write`].
pub trait PackTo: Sized + Copy {
    /// Pack binary data into `dst`.
    /// # Example
    /// ```rust
    /// use std::io::Cursor;
    /// use byteorder::BigEndian;
    /// use byteorder_pack::PackTo;
    ///
    /// let mut cursor = Cursor::new(vec![]);
    ///
    /// (1u8, 2u8, 3u16, 4u16).pack_to::<BigEndian, _>(&mut cursor).unwrap();
    ///
    /// assert_eq!(cursor.into_inner(), vec![0x01, 0x02, 0x00, 0x03, 0x00, 0x04]);
    /// ```
    fn pack_to<E: ByteOrder, W: Write + ?Sized>(self, dst: &mut W) -> IoResult<()>;

    /// Pack binary data into `dst` from a tuple, in [`BigEndian`] order.
    /// # Example
    /// ```rust
    /// use std::io::Cursor;
    /// use byteorder_pack::PackTo;
    ///
    /// let mut cursor = Cursor::new(vec![]);
    ///
    /// (1u8, 2u8, 3u16, 4u16).pack_to_be(&mut cursor).unwrap();
    ///
    /// assert_eq!(cursor.into_inner(), vec![0x01, 0x02, 0x00, 0x03, 0x00, 0x04]);
    /// ```
    fn pack_to_be<W: Write + ?Sized>(self, dst: &mut W) -> IoResult<()> {
        self.pack_to::<BigEndian, _>(dst)
    }
    /// Pack binary data into `dst` from a tuple, in [`LittleEndian`] order.
    /// # Example
    /// ```rust
    /// use std::io::Cursor;
    /// use byteorder_pack::PackTo;
    ///
    /// let mut cursor = Cursor::new(vec![]);
    ///
    /// (1u8, 2u8, 3u16, 4u16).pack_to_le(&mut cursor).unwrap();
    ///
    /// assert_eq!(cursor.into_inner(), vec![0x01, 0x02, 0x03, 0x00, 0x04, 0x00]);
    /// ```
    fn pack_to_le<W: Write + ?Sized>(self, dst: &mut W) -> IoResult<()> {
        self.pack_to::<LittleEndian, _>(dst)
    }

    /// Pack multiple values into `dest`.
    fn pack_multiple_to<E: ByteOrder, W: Write + ?Sized>(
        buf: &[Self],
        dst: &mut W,
    ) -> IoResult<()> {
        for i in buf {
            i.pack_to::<E, _>(dst)?;
        }
        Ok(())
    }
}

macro_rules! impl_tuple {
    ($($n:tt => $t:ident),+) => {
        impl<$($t: PackTo),+> PackTo for ($($t,)+)
        {
            #[inline]
            fn pack_to<E: ByteOrder, W: Write + ?Sized>(self, dst: &mut W) -> IoResult<()> {
                $(self.$n.pack_to::<E, _>(dst)?;)+
                Ok(())
            }
        }
    };
}
impl_tuple!(0 => T1);
impl_tuple!(0 => T1, 1 => T2);
impl_tuple!(0 => T1, 1 => T2, 2 => T3);
impl_tuple!(0 => T1, 1 => T2, 2 => T3, 3 => T4);
impl_tuple!(0 => T1, 1 => T2, 2 => T3, 3 => T4, 4 => T5);
impl_tuple!(0 => T1, 1 => T2, 2 => T3, 3 => T4, 4 => T5, 5 => T6);
impl_tuple!(0 => T1, 1 => T2, 2 => T3, 3 => T4, 4 => T5, 5 => T6, 6 => T7);
impl_tuple!(0 => T1, 1 => T2, 2 => T3, 3 => T4, 4 => T5, 5 => T6, 6 => T7, 7 => T8);
impl_tuple!(
    0 => T1, 1 => T2, 2 => T3, 3 => T4, 4 => T5, 5 => T6,
    6 => T7, 7 => T8, 8 => T9
);
impl_tuple!(
    0 => T1, 1 => T2, 2 => T3, 3 => T4, 4 => T5, 5 => T6,
    6 => T7, 7 => T8, 8 => T9, 9 => T10
);
impl_tuple!(
    0 => T1, 1 => T2, 2 => T3, 3 => T4, 4 => T5, 5 => T6,
    6 => T7, 7 => T8, 8 => T9, 9 => T10, 10 => T11
);
impl_tuple!(
    0 => T1, 1 => T2, 2 => T3, 3 => T4, 4 => T5, 5 => T6,
    6 => T7, 7 => T8, 8 => T9, 9 => T10, 10 => T11, 11 => T12
);

macro_rules! impl_primitive {
    ($($name:ident => $ty:ty),+) => {
        $(
            impl PackTo for $ty {
                fn pack_to<E: ByteOrder, W: Write + ?Sized>(self, src: &mut W) -> IoResult<()> {
                    src.$name::<E>(self)
                }
            }
        )+
    };
}

impl_primitive!(
    write_u16 => u16, write_u32 => u32, write_u64 => u64, write_u128 => u128,
    write_i16 => i16, write_i32 => i32, write_i64 => i64, write_i128 => i128,
    write_f32 => f32, write_f64 => f64
);

impl PackTo for u8 {
    fn pack_to<E: ByteOrder, W: Write + ?Sized>(self, dst: &mut W) -> IoResult<()> {
        dst.write_u8(self)
    }

    fn pack_multiple_to<E: ByteOrder, W: Write + ?Sized>(
        buf: &[Self],
        dst: &mut W,
    ) -> IoResult<()> {
        dst.write_all(buf)?;
        Ok(())
    }
}

impl PackTo for i8 {
    fn pack_to<E: ByteOrder, W: Write + ?Sized>(self, dst: &mut W) -> IoResult<()> {
        dst.write_i8(self)
    }
}

impl<T: PackTo + Copy, const N: usize> PackTo for [T; N] {
    fn pack_to<E: ByteOrder, W: Write + ?Sized>(self, dst: &mut W) -> IoResult<()> {
        T::pack_multiple_to::<E, _>(&self[..], dst)?;
        Ok(())
    }
}

impl<T: PackTo + Copy> PackTo for &[T] {
    fn pack_to<E: ByteOrder, W: Write + ?Sized>(self, dst: &mut W) -> IoResult<()> {
        T::pack_multiple_to::<E, _>(self, dst)?;
        Ok(())
    }
}