qubit-io 0.3.0

Small stream I/O trait utilities for Rust
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
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294

use std::io::{
    Cursor,
    ErrorKind,
};

use qubit_io::{
    ByteOrder,
    StringReadExt,
};

#[test]
fn test_string_read_ext_reads_all_length_prefix_kinds() {
    let mut input = Cursor::new(b"raw".to_vec());
    assert_eq!(
        "raw",
        input
            .read_utf8_payload(3, 8)
            .expect("known-length payload should be read")
    );

    let mut input = Cursor::new(vec![5, b'h', b'e', b'l', b'l', b'o']);
    assert_eq!(
        "hello",
        input.read_utf8_string_uleb(8).expect("ULEB string should be read")
    );

    let mut input = Cursor::new(vec![5, b'h', b'e', b'l', b'l', b'o']);
    assert_eq!(
        "hello",
        input
            .read_utf8_string_uleb_strict(8)
            .expect("strict ULEB string should be read")
    );

    let mut input = Cursor::new(vec![0, 2, b'h', b'i']);
    assert_eq!(
        "hi",
        input.read_utf8_string_u16_be(8).expect("u16 BE string should be read")
    );

    let mut input = Cursor::new(vec![0, 2, b'h', b'i']);
    assert_eq!(
        "hi",
        input
            .read_utf8_string_u16(ByteOrder::BigEndian, 8)
            .expect("runtime u16 BE string should be read")
    );

    let mut input = Cursor::new(vec![2, 0, b'h', b'i']);
    assert_eq!(
        "hi",
        input.read_utf8_string_u16_le(8).expect("u16 LE string should be read")
    );

    let mut input = Cursor::new(vec![2, 0, b'h', b'i']);
    assert_eq!(
        "hi",
        input
            .read_utf8_string_u16(ByteOrder::LittleEndian, 8)
            .expect("runtime u16 LE string should be read")
    );

    let mut input = Cursor::new(vec![0, 0, 0, 2, b'o', b'k']);
    assert_eq!(
        "ok",
        input.read_utf8_string_u32_be(8).expect("u32 BE string should be read")
    );

    let mut input = Cursor::new(vec![0, 0, 0, 2, b'o', b'k']);
    assert_eq!(
        "ok",
        input
            .read_utf8_string_u32(ByteOrder::BigEndian, 8)
            .expect("runtime u32 BE string should be read")
    );

    let mut input = Cursor::new(vec![2, 0, 0, 0, b'o', b'k']);
    assert_eq!(
        "ok",
        input.read_utf8_string_u32_le(8).expect("u32 LE string should be read")
    );

    let mut input = Cursor::new(vec![2, 0, 0, 0, b'o', b'k']);
    assert_eq!(
        "ok",
        input
            .read_utf8_string_u32(ByteOrder::LittleEndian, 8)
            .expect("runtime u32 LE string should be read")
    );
}

#[test]
fn test_string_read_ext_reports_length_and_utf8_errors() {
    let mut input = Cursor::new(vec![b'a', b'b', b'c']);
    assert_eq!(
        ErrorKind::InvalidData,
        input
            .read_utf8_payload(3, 2)
            .expect_err("oversized known-length payload should fail")
            .kind()
    );

    let mut input = Cursor::new(vec![3, b'a', b'b', b'c']);
    assert_eq!(
        ErrorKind::InvalidData,
        input
            .read_utf8_string_uleb(2)
            .expect_err("oversized ULEB string should fail")
            .kind()
    );

    let mut input = Cursor::new(vec![0x80, 0x00, b'a']);
    assert_eq!(
        ErrorKind::InvalidData,
        input
            .read_utf8_string_uleb_strict(8)
            .expect_err("non-canonical ULEB length should fail")
            .kind()
    );

    let mut input = Cursor::new(vec![0, 2, 0xff, 0xff]);
    assert_eq!(
        ErrorKind::InvalidData,
        input
            .read_utf8_string_u16_be(8)
            .expect_err("invalid UTF-8 should fail")
            .kind()
    );

    let mut input = Cursor::new(vec![2, 0, 0xff, 0xff]);
    assert_eq!(
        ErrorKind::InvalidData,
        input
            .read_utf8_string_u16_le(8)
            .expect_err("invalid UTF-8 should fail")
            .kind()
    );

    let mut input = Cursor::new(vec![0, 0, 0, 3, b'a', b'b', b'c']);
    assert_eq!(
        ErrorKind::InvalidData,
        input
            .read_utf8_string_u32_be(2)
            .expect_err("oversized u32 BE string should fail")
            .kind()
    );

    let mut input = Cursor::new(vec![3, 0, 0, 0, b'a', b'b', b'c']);
    assert_eq!(
        ErrorKind::InvalidData,
        input
            .read_utf8_string_u32_le(2)
            .expect_err("oversized u32 LE string should fail")
            .kind()
    );

    let mut input = Cursor::new(vec![0x00, 0x03, b'a', b'b', b'c']);
    assert_eq!(
        ErrorKind::InvalidData,
        input
            .read_utf8_string_u16(ByteOrder::BigEndian, 2)
            .expect_err("oversized runtime u16 string should fail")
            .kind()
    );

    let mut input = Cursor::new(vec![0x03, 0x00, b'a', b'b', b'c']);
    assert_eq!(
        ErrorKind::InvalidData,
        input
            .read_utf8_string_u16(ByteOrder::LittleEndian, 2)
            .expect_err("oversized runtime little-endian u16 string should fail")
            .kind()
    );

    let mut input = Cursor::new(vec![0x00, 0x00, 0x00, 0x03, b'a', b'b', b'c']);
    assert_eq!(
        ErrorKind::InvalidData,
        input
            .read_utf8_string_u32(ByteOrder::BigEndian, 2)
            .expect_err("oversized runtime u32 string should fail")
            .kind()
    );

    let mut input = Cursor::new(vec![0x03, 0x00, 0x00, 0x00, b'a', b'b', b'c']);
    assert_eq!(
        ErrorKind::InvalidData,
        input
            .read_utf8_string_u32(ByteOrder::LittleEndian, 2)
            .expect_err("oversized runtime little-endian u32 string should fail")
            .kind()
    );
}

#[test]
fn test_string_read_ext_returns_payload_read_error() {
    let mut input = Cursor::new(vec![2, b'a']);
    assert_eq!(
        ErrorKind::UnexpectedEof,
        input
            .read_utf8_string_uleb(8)
            .expect_err("truncated payload should fail")
            .kind()
    );

    let mut reader = Cursor::new(Vec::<u8>::new());
    assert_eq!(
        ErrorKind::UnexpectedEof,
        reader
            .read_utf8_string_uleb(8)
            .expect_err("length read error should be returned")
            .kind()
    );

    let mut reader = Cursor::new(vec![0x00]);
    assert_eq!(
        ErrorKind::UnexpectedEof,
        reader
            .read_utf8_string_u16(ByteOrder::BigEndian, 8)
            .expect_err("runtime u16 length read error should be returned")
            .kind()
    );

    let mut reader = Cursor::new(vec![0x00]);
    assert_eq!(
        ErrorKind::UnexpectedEof,
        reader
            .read_utf8_string_u16(ByteOrder::LittleEndian, 8)
            .expect_err("runtime little-endian u16 length read error should be returned")
            .kind()
    );

    let mut reader = Cursor::new(vec![0x00]);
    assert_eq!(
        ErrorKind::UnexpectedEof,
        reader
            .read_utf8_string_u16_be(8)
            .expect_err("u16 BE length read error should be returned")
            .kind()
    );

    let mut reader = Cursor::new(vec![0x00]);
    assert_eq!(
        ErrorKind::UnexpectedEof,
        reader
            .read_utf8_string_u16_le(8)
            .expect_err("u16 LE length read error should be returned")
            .kind()
    );

    let mut reader = Cursor::new(vec![0x00, 0x00, 0x00]);
    assert_eq!(
        ErrorKind::UnexpectedEof,
        reader
            .read_utf8_string_u32(ByteOrder::BigEndian, 8)
            .expect_err("runtime u32 length read error should be returned")
            .kind()
    );

    let mut reader = Cursor::new(vec![0x00, 0x00, 0x00]);
    assert_eq!(
        ErrorKind::UnexpectedEof,
        reader
            .read_utf8_string_u32(ByteOrder::LittleEndian, 8)
            .expect_err("runtime little-endian u32 length read error should be returned")
            .kind()
    );

    let mut reader = Cursor::new(vec![0x00, 0x00, 0x00]);
    assert_eq!(
        ErrorKind::UnexpectedEof,
        reader
            .read_utf8_string_u32_be(8)
            .expect_err("u32 BE length read error should be returned")
            .kind()
    );

    let mut reader = Cursor::new(vec![0x00, 0x00, 0x00]);
    assert_eq!(
        ErrorKind::UnexpectedEof,
        reader
            .read_utf8_string_u32_le(8)
            .expect_err("u32 LE length read error should be returned")
            .kind()
    );

    let mut input = Cursor::new(Vec::<u8>::new());
    assert_eq!(
        ErrorKind::Other,
        input
            .read_utf8_payload(usize::MAX, usize::MAX)
            .expect_err("payload allocation error should be returned")
            .kind()
    );
}