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
use std::io::{Read, Result};
use std::mem::size_of;

use crate::Endianness;

macro_rules! read_method {
    ($name:ident, $Ty:ty, $value:expr, $be_slice:expr, $le_slice:expr) => {
        doc!(
            concat!("Reads a [`", stringify!($Ty), "`] value from the")
            "underlying reader."
            ""
            "# Errors"
            ""
            "This method returns the same errors as [`Read::read_exact`]."
            ""
            "# Examples"
            ""
            "```"
            "use byte_order::{Endianness, EndianReader};"
            ""
            concat!("let be_bytes: &[u8] = ", stringify!($be_slice), ";")
            "let mut be_reader = EndianReader::with_order(Endianness::BE, be_bytes);"
            concat!("let value = be_reader.", stringify!($name), "().unwrap();")
            ""
            concat!("assert_eq!(value, ", stringify!($value), stringify!($Ty), ");")
            "```"
            ""
            "```"
            "use byte_order::{Endianness, EndianReader};"
            ""
            concat!("let le_bytes: &[u8] = ", stringify!($le_slice), ";")
            "let mut le_reader = EndianReader::with_order(Endianness::LE, le_bytes);"
            concat!("let value = le_reader.", stringify!($name), "().unwrap();")
            ""
            concat!("assert_eq!(value, ", stringify!($value), stringify!($Ty), ");")
            "```";
            pub fn $name(&mut self) -> Result<$Ty> {
                let mut bytes = [0; size_of::<$Ty>()];
                self.inner.read_exact(&mut bytes)?;
                Ok(match self.order {
                    Endianness::BE => <$Ty>::from_be_bytes(bytes),
                    Endianness::LE => <$Ty>::from_le_bytes(bytes),
                })
            }
        );
    };
}

macro_rules! read_method_pair {
    (
        $unsigned_name:ident,
        $U:ty,
        $signed_name:ident,
        $S:ty,
        $value:expr,
        $be_vec: expr,
        $le_vec:expr
    ) => {
        read_method!($unsigned_name, $U, $value, $be_vec, $le_vec);
        read_method!($signed_name, $S, $value, $be_vec, $le_vec);
    };
}

pub struct EndianReader<R: Read> {
    inner: R,
    order: Endianness,
}

impl<R: Read> EndianReader<R> {
    /// Creates a new byte reader wrapping the provided reader. Endianness is
    /// derived from native byte order.
    ///
    /// Since the target platform's endianness is used, portable code should use
    /// [`EndianReader::with_order`], as appropriate.
    ///
    /// # Examples
    ///
    /// ```
    /// use std::io::Cursor;
    /// use byte_order::EndianReader;
    ///
    /// let rdr = EndianReader::new(Cursor::new(vec![]));
    /// ```
    #[inline]
    pub fn new(reader: R) -> EndianReader<R> {
        let order = if cfg!(target_endian = "big") {
            Endianness::BE
        } else {
            Endianness::LE
        };
        EndianReader::with_order(order, reader)
    }

    /// Creates a new endian reader wrapping the provided reader. An order is
    /// also required, either [`Endianness::BE`] for big-endian or
    /// [`Endianness::LE`] for little-endian byte ordering.
    ///
    /// # Examples
    ///
    /// ```
    /// use std::io::Cursor;
    /// use byte_order::{Endianness, EndianReader};
    ///
    /// let be_reader = EndianReader::with_order(Endianness::BE, Cursor::new(vec![]));
    /// let le_reader = EndianReader::with_order(Endianness::LE, Cursor::new(vec![]));
    /// ```
    #[inline]
    pub fn with_order(order: Endianness, reader: R) -> EndianReader<R> {
        EndianReader {
            inner: reader,
            order,
        }
    }

    /// Consumes this byte reader, returning the underlying reader.
    ///
    /// # Examples
    ///
    /// ```
    /// use std::io::Cursor;
    /// use byte_order::EndianReader;
    ///
    /// let reader = EndianReader::new(Cursor::new(vec![]));
    ///
    /// let cursor = reader.into_inner();
    /// ```
    #[inline]
    pub fn into_inner(self) -> R {
        self.inner
    }

    /// Gets a reference to the underlying reader of this byte reader.
    ///
    /// # Examples
    ///
    /// ```
    /// use std::io::Cursor;
    /// use byte_order::EndianReader;
    ///
    /// let reader = EndianReader::new(Cursor::new(vec![]));
    ///
    /// let cursor_reference = reader.get_ref();
    /// ```
    #[inline]
    pub fn get_ref(&self) -> &R {
        &self.inner
    }

    /// Gets a mutable reference to the underlying reader of this byte reader.
    ///
    /// Care should be taken to avoid modifying the internal I/O state of the
    /// underlying reader as it may corrupt reading and writing numbers.
    ///
    /// ```
    /// use std::io::Cursor;
    /// use byte_order::EndianReader;
    ///
    /// let mut reader = EndianReader::new(Cursor::new(vec![]));
    ///
    /// let cursor_reference = reader.get_mut();
    /// ```
    #[inline]
    pub fn get_mut(&mut self) -> &mut R {
        &mut self.inner
    }

    read_method_pair!(read_u8, u8, read_i8, i8, 0x12, &[0x12], &[0x12]);

    read_method_pair!(
        read_u16,
        u16,
        read_i16,
        i16,
        0x1234,
        &[0x12, 0x34],
        &[0x34, 0x12]
    );

    read_method_pair!(
        read_u32,
        u32,
        read_i32,
        i32,
        0x12345678,
        &[0x12, 0x34, 0x56, 0x78],
        &[0x78, 0x56, 0x34, 0x12]
    );

    read_method_pair!(
        read_u64,
        u64,
        read_i64,
        i64,
        0x1234567890123456,
        &[0x12, 0x34, 0x56, 0x78, 0x90, 0x12, 0x34, 0x56],
        &[0x56, 0x34, 0x12, 0x90, 0x78, 0x56, 0x34, 0x12]
    );

    read_method_pair!(
        read_u128,
        u128,
        read_i128,
        i128,
        0x12345678901234567890123456789012,
        &[
            0x12, 0x34, 0x56, 0x78, 0x90, 0x12, 0x34, 0x56, 0x78, 0x90, 0x12, 0x34, 0x56, 0x78,
            0x90, 0x12
        ],
        &[
            0x12, 0x90, 0x78, 0x56, 0x34, 0x12, 0x90, 0x78, 0x56, 0x34, 0x12, 0x90, 0x78, 0x56,
            0x34, 0x12
        ]
    );
}