dh 0.11.0

Data handling in Rust, made easy.
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
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

#[cfg(feature = "vli")]
use crate::variable;
use crate::{Endianess, Primitive, Result};
use std::io::{Read, Seek, Write};

macro_rules! read_primitive {
    ($fn_name:ident, $read_fn_name:ident) => {
        /// Reads a primitive value from the reader using the specified byte order.
        ///
        /// It's recommended to use the typed wrappers like `read_u8` instead of this method for cleaner code.
        fn $fn_name<T: Primitive<U, S>, U, const S: usize>(&mut self) -> Result<T> {
            let mut buf = [0; S];
            self.read_exact(&mut buf)?;
            Ok(T::$read_fn_name(buf))
        }
    };
}

macro_rules! read_primitive_typed {
    ($fn_name:ident, $return_type:ty, $read_fn:ident) => {
        /// Typed wrapper around `read_ne`, `read_le`, or `read_be`.
        fn $fn_name(&mut self) -> Result<$return_type> {
            self.$read_fn()
        }
    };

    ($fn_name:ident, $return_type:ty) => {
        /// Typed wrapper around `read_ne`, `read_le`, or `read_be`.
        fn $fn_name(&mut self, endianess: Endianess) -> Result<$return_type> {
            use Endianess::*;
            match endianess {
                Little => self.read_le(),
                Big => self.read_be(),
                Native => self.read_ne(),
            }
        }
    };

    ($fn_name:ident, $return_type:ty, $read_fn:ident, $const:ident) => {
        /// Typed wrapper around `read_ne`, `read_le`, or `read_be`.
        fn $fn_name<const $const: usize>(&mut self) -> Result<$return_type> {
            self.$read_fn::<$return_type, $return_type, $const>()
        }
    };
}

macro_rules! read_dynamic_typed {
    ($fn_name:ident, $return_type:ty) => {
        /// Typed wrapper around `read_dynamic`.
        fn $fn_name(&mut self, len: usize) -> Result<$return_type> {
            self.read_dynamic(len)
        }
    };
}

macro_rules! read_variable {
    ($fn_name:ident) => {
        /// Reads a variable-length integer from the reader.
        #[cfg(feature = "vli")]
        fn $fn_name(&mut self) -> Result<u128> {
            variable::$fn_name(self)
        }
    };
}

/// Extension trait for `Read` that provides methods for reading supported value types.
///
/// **Note:** do not borrow this as `&mut dyn ReadVal`, as this would not compile. Use `&mut dyn Read` instead.
pub trait ReadVal: Read {
    read_variable!(read_vu8);
    read_variable!(read_vu16_ne);
    read_variable!(read_vu16_le);
    read_variable!(read_vu16_be);
    read_variable!(read_vu32_ne);
    read_variable!(read_vu32_le);
    read_variable!(read_vu32_be);
    read_variable!(read_vu64_ne);
    read_variable!(read_vu64_le);
    read_variable!(read_vu64_be);
    read_variable!(read_vu128_ne);
    read_variable!(read_vu128_le);
    read_variable!(read_vu128_be);

    read_primitive_typed!(read_u8, u8, read_ne);

    read_primitive_typed!(read_u16, u16);
    read_primitive_typed!(read_u32, u32);
    read_primitive_typed!(read_u64, u64);
    read_primitive_typed!(read_u128, u128);
    read_primitive_typed!(read_usize, usize);

    read_primitive_typed!(read_i8, i8, read_ne);

    read_primitive_typed!(read_i16, i16);
    read_primitive_typed!(read_i32, i32);
    read_primitive_typed!(read_i64, i64);
    read_primitive_typed!(read_i128, i128);
    read_primitive_typed!(read_isize, isize);

    read_primitive_typed!(read_f32, f32);
    read_primitive_typed!(read_f64, f64);

    read_primitive_typed!(read_u8_array, [u8; S], read_ne, S);

    read_primitive_typed!(read_bool, bool, read_ne);

    read_dynamic_typed!(read_vec, Vec<u8>);
    read_dynamic_typed!(read_str, String);

    read_primitive!(read_ne, from_ne_bytes);
    read_primitive!(read_le, from_le_bytes);
    read_primitive!(read_be, from_be_bytes);

    read_primitive_typed!(read_u16_ne, u16, read_ne);
    read_primitive_typed!(read_u16_le, u16, read_le);
    read_primitive_typed!(read_u16_be, u16, read_be);

    read_primitive_typed!(read_u32_ne, u32, read_ne);
    read_primitive_typed!(read_u32_le, u32, read_le);
    read_primitive_typed!(read_u32_be, u32, read_be);

    read_primitive_typed!(read_u64_ne, u64, read_ne);
    read_primitive_typed!(read_u64_le, u64, read_le);
    read_primitive_typed!(read_u64_be, u64, read_be);

    read_primitive_typed!(read_u128_ne, u128, read_ne);
    read_primitive_typed!(read_u128_le, u128, read_le);
    read_primitive_typed!(read_u128_be, u128, read_be);

    read_primitive_typed!(read_usize_ne, usize, read_ne);
    read_primitive_typed!(read_usize_le, usize, read_le);
    read_primitive_typed!(read_usize_be, usize, read_be);

    read_primitive_typed!(read_i16_ne, i16, read_ne);
    read_primitive_typed!(read_i16_le, i16, read_le);
    read_primitive_typed!(read_i16_be, i16, read_be);

    read_primitive_typed!(read_i32_ne, i32, read_ne);
    read_primitive_typed!(read_i32_le, i32, read_le);
    read_primitive_typed!(read_i32_be, i32, read_be);

    read_primitive_typed!(read_i64_ne, i64, read_ne);
    read_primitive_typed!(read_i64_le, i64, read_le);
    read_primitive_typed!(read_i64_be, i64, read_be);

    read_primitive_typed!(read_i128_ne, i128, read_ne);
    read_primitive_typed!(read_i128_le, i128, read_le);
    read_primitive_typed!(read_i128_be, i128, read_be);

    read_primitive_typed!(read_isize_ne, isize, read_ne);
    read_primitive_typed!(read_isize_le, isize, read_le);
    read_primitive_typed!(read_isize_be, isize, read_be);

    read_primitive_typed!(read_f32_ne, f32, read_ne);
    read_primitive_typed!(read_f32_le, f32, read_le);
    read_primitive_typed!(read_f32_be, f32, read_be);

    read_primitive_typed!(read_f64_ne, f64, read_ne);
    read_primitive_typed!(read_f64_le, f64, read_le);
    read_primitive_typed!(read_f64_be, f64, read_be);

    /// Reads a dynamic value from the reader.
    ///
    /// It's recommended to use the typed wrappers like `read_vec` instead of this method for cleaner code.
    fn read_dynamic<T: crate::Dynamic>(&mut self, len: usize) -> Result<T> {
        let mut buf = vec![0; len];
        self.read_exact(&mut buf)?;
        T::from_bytes(buf)
    }

    fn copy(&mut self, len: u64, mut target: &mut dyn Write) -> Result<()> {
        let mut limited = self.take(len);
        std::io::copy(&mut limited, &mut target)?;
        Ok(())
    }

    fn copy_to(
        &mut self,
        len: u64,
        targetpos: u64,
        mut target: &mut (impl Write + Seek),
    ) -> Result<()> {
        let current_pos = target.stream_position()?;
        target.seek(std::io::SeekFrom::Start(targetpos))?;
        let mut limited = self.take(len);
        std::io::copy(&mut limited, &mut target)?;
        target.seek(std::io::SeekFrom::Start(current_pos))?;
        Ok(())
    }
}

impl<T: Read> ReadVal for T {}