qubit-io 0.6.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
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
// =============================================================================
//    Copyright (c) 2026 Haixing Hu.
//
//    SPDX-License-Identifier: Apache-2.0
//
//    Licensed under the Apache License, Version 2.0
// =============================================================================
use std::cmp::Ordering;
use std::io::{
    Cursor,
    Error,
    ErrorKind,
    Read,
    Write,
};

use qubit_io::{
    ReadExt,
    Streams,
};

struct InterruptedOnceReader {
    interrupted: bool,
    data: Cursor<Vec<u8>>,
}

impl InterruptedOnceReader {
    fn new(data: &[u8]) -> Self {
        Self {
            interrupted: false,
            data: Cursor::new(data.to_vec()),
        }
    }
}

impl Read for InterruptedOnceReader {
    fn read(&mut self, buffer: &mut [u8]) -> std::io::Result<usize> {
        if !self.interrupted {
            self.interrupted = true;
            return Err(Error::new(ErrorKind::Interrupted, "interrupted once"));
        }
        self.data.read(buffer)
    }
}

struct FailingReader;

impl Read for FailingReader {
    fn read(&mut self, _buffer: &mut [u8]) -> std::io::Result<usize> {
        Err(Error::other("read failed"))
    }
}

struct FailingWriter;

impl Write for FailingWriter {
    fn write(&mut self, _buffer: &[u8]) -> std::io::Result<usize> {
        Err(Error::other("write failed"))
    }

    fn flush(&mut self) -> std::io::Result<()> {
        Ok(())
    }
}

struct PanicOnRead;

impl Read for PanicOnRead {
    fn read(&mut self, _buffer: &mut [u8]) -> std::io::Result<usize> {
        panic!("zero-byte copy must not read")
    }
}

struct InterruptThenEofReader {
    data: Cursor<Vec<u8>>,
    interrupted: bool,
}

impl InterruptThenEofReader {
    fn new(data: &[u8]) -> Self {
        Self {
            data: Cursor::new(data.to_vec()),
            interrupted: false,
        }
    }
}

impl Read for InterruptThenEofReader {
    fn read(&mut self, buffer: &mut [u8]) -> std::io::Result<usize> {
        if self.data.position() < self.data.get_ref().len() as u64 {
            return self.data.read(buffer);
        }
        if !self.interrupted {
            self.interrupted = true;
            return Err(Error::new(
                ErrorKind::Interrupted,
                "interrupted at eof",
            ));
        }
        Ok(0)
    }
}

struct FailAfterDataReader {
    data: Cursor<Vec<u8>>,
}

impl FailAfterDataReader {
    fn new(data: &[u8]) -> Self {
        Self {
            data: Cursor::new(data.to_vec()),
        }
    }
}

impl Read for FailAfterDataReader {
    fn read(&mut self, buffer: &mut [u8]) -> std::io::Result<usize> {
        if self.data.position() < self.data.get_ref().len() as u64 {
            return self.data.read(buffer);
        }
        Err(Error::other("tail read failed"))
    }
}

#[test]
fn test_copy_at_most_copies_at_most_requested_bytes() {
    let mut input = Cursor::new(b"abcdef".to_vec());
    let mut output = Vec::new();

    let copied = Streams::copy_at_most(&mut input, &mut output, 4)
        .expect("copy should succeed");

    assert_eq!(4, copied);
    assert_eq!(b"abcd", output.as_slice());
    assert_eq!(4, input.position());
}

#[test]
fn test_copy_at_most_returns_partial_count_at_eof() {
    let mut input = Cursor::new(b"abc".to_vec());
    let mut output = Vec::new();

    let copied = Streams::copy_at_most(&mut input, &mut output, 5)
        .expect("copy should stop at EOF");

    assert_eq!(3, copied);
    assert_eq!(b"abc", output.as_slice());
}

#[test]
fn test_copy_at_most_zero_bytes_does_not_read() {
    let mut input = PanicOnRead;
    let mut output = Vec::new();

    let copied = Streams::copy_at_most(&mut input, &mut output, 0)
        .expect("zero-byte copy should succeed");

    assert_eq!(0, copied);
    assert!(output.is_empty());
}

#[test]
fn test_copy_at_most_retries_interrupted_reads() {
    let mut input = InterruptedOnceReader::new(b"abc");
    let mut output = Vec::new();

    let copied = Streams::copy_at_most(&mut input, &mut output, 3)
        .expect("interrupted reads should be retried");

    assert_eq!(3, copied);
    assert_eq!(b"abc", output.as_slice());
}

#[test]
fn test_copy_at_most_returns_read_error() {
    let mut input = FailingReader;
    let mut output = Vec::new();

    let error = Streams::copy_at_most(&mut input, &mut output, 3)
        .expect_err("non-interrupted read errors should be returned");

    assert_eq!(ErrorKind::Other, error.kind());
    assert_eq!("read failed", error.to_string());
}

#[test]
fn test_copy_at_most_returns_write_error() {
    let mut input = Cursor::new(b"abc".to_vec());
    let mut output = FailingWriter;

    let error = Streams::copy_at_most(&mut input, &mut output, 3)
        .expect_err("write errors should be returned");

    assert_eq!(ErrorKind::Other, error.kind());
    assert_eq!("write failed", error.to_string());
}

#[test]
fn test_copy_copies_until_eof() {
    let mut input = Cursor::new(b"abcdef".to_vec());
    let mut output = Vec::new();

    let copied =
        Streams::copy(&mut input, &mut output).expect("copy should reach EOF");

    assert_eq!(6, copied);
    assert_eq!(b"abcdef", output.as_slice());
}

#[test]
fn test_copy_returns_read_error() {
    let mut input = FailingReader;
    let mut output = Vec::new();

    let error = Streams::copy(&mut input, &mut output)
        .expect_err("std copy read errors should be returned");

    assert_eq!(ErrorKind::Other, error.kind());
    assert_eq!("read failed", error.to_string());
}

#[test]
fn test_copy_functions_work_on_dyn_read_write() {
    let mut input = Cursor::new(b"abcdef".to_vec());
    let reader: &mut dyn Read = &mut input;
    let mut output = Vec::new();
    let writer: &mut dyn Write = &mut output;

    let copied =
        Streams::copy_at_most::<dyn Read, dyn Write>(reader, writer, 3)
            .expect("dyn copy should succeed");

    assert_eq!(3, copied);
    assert_eq!(b"abc", output.as_slice());

    let mut input = Cursor::new(b"xyz".to_vec());
    let reader: &mut dyn Read = &mut input;
    let mut output = Vec::new();
    let writer: &mut dyn Write = &mut output;

    let copied =
        Streams::copy_to_end_limited::<dyn Read, dyn Write>(reader, writer, 3)
            .expect("dyn end-limited copy should succeed");

    assert_eq!(3, copied);
    assert_eq!(b"xyz", output.as_slice());
}

#[test]
fn test_copy_to_method_copies_remaining_bytes() {
    let mut input = Cursor::new(b"abcdef".to_vec());
    let mut output = Vec::new();

    let copied = input
        .copy_to(&mut output)
        .expect("copy_to should copy until EOF");

    assert_eq!(6, copied);
    assert_eq!(b"abcdef", output.as_slice());
}

#[test]
fn test_copy_to_end_limited_returns_dyn_tail_probe_error() {
    let mut input = FailingReader;
    let reader: &mut dyn Read = &mut input;
    let mut output = Vec::new();

    let error = Streams::copy_to_end_limited::<dyn Read, Vec<u8>>(
        reader,
        &mut output,
        0,
    )
    .expect_err("dyn tail probe errors should be returned");

    assert_eq!(ErrorKind::Other, error.kind());
    assert_eq!("read failed", error.to_string());
}

#[test]
fn test_copy_to_at_most_method_copies_at_most_requested_bytes() {
    let mut input = Cursor::new(b"abcdef".to_vec());
    let mut output = Vec::new();

    let copied = input
        .copy_to_at_most(&mut output, 4)
        .expect("copy_to_at_most should stop at the limit");

    assert_eq!(4, copied);
    assert_eq!(b"abcd", output.as_slice());
    assert_eq!(4, input.position());
}

#[test]
fn test_copy_to_end_limited_copies_exact_length() {
    let mut input = Cursor::new(b"abcd".to_vec());
    let mut output = Vec::new();

    let copied = Streams::copy_to_end_limited(&mut input, &mut output, 4)
        .expect("copy_to_end_limited should accept exact-length input");

    assert_eq!(4, copied);
    assert_eq!(b"abcd", output.as_slice());
    assert_eq!(4, input.position());
}

#[test]
fn test_copy_to_end_limited_copies_shorter_input() {
    let mut input = Cursor::new(b"abc".to_vec());
    let mut output = Vec::new();

    let copied = Streams::copy_to_end_limited(&mut input, &mut output, 4)
        .expect("copy_to_end_limited should stop at EOF");

    assert_eq!(3, copied);
    assert_eq!(b"abc", output.as_slice());
    assert_eq!(3, input.position());
}

#[test]
fn test_copy_to_end_limited_rejects_oversized_input() {
    let mut input = Cursor::new(b"abcdef".to_vec());
    let mut output = Vec::new();

    let error = Streams::copy_to_end_limited(&mut input, &mut output, 4)
        .expect_err("copy_to_end_limited should reject oversized input");

    assert_eq!(ErrorKind::InvalidData, error.kind());
    assert_eq!("input exceeds maximum length of 4 bytes", error.to_string());
    assert_eq!(b"abcd", output.as_slice());
    assert_eq!(5, input.position());
}

#[test]
fn test_copy_to_end_limited_retries_interrupted_tail_probe() {
    let mut input = InterruptThenEofReader::new(b"abcd");
    let mut output = Vec::new();

    let copied = Streams::copy_to_end_limited(&mut input, &mut output, 4)
        .expect("interrupted EOF probe should be retried");

    assert_eq!(4, copied);
    assert_eq!(b"abcd", output.as_slice());
}

#[test]
fn test_copy_to_end_limited_returns_copy_read_error() {
    let mut input = FailingReader;
    let mut output = Vec::new();

    let error = Streams::copy_to_end_limited(&mut input, &mut output, 4)
        .expect_err("copy read errors should be returned");

    assert_eq!(ErrorKind::Other, error.kind());
    assert_eq!("read failed", error.to_string());
    assert!(output.is_empty());
}

#[test]
fn test_copy_to_end_limited_returns_copy_write_error() {
    let mut input = Cursor::new(b"abcd".to_vec());
    let mut output = FailingWriter;

    let error = Streams::copy_to_end_limited(&mut input, &mut output, 4)
        .expect_err("copy write errors should be returned");

    assert_eq!(ErrorKind::Other, error.kind());
    assert_eq!("write failed", error.to_string());
}

#[test]
fn test_copy_to_end_limited_returns_tail_probe_error() {
    let mut input = FailAfterDataReader::new(b"abcd");
    let mut output = Vec::new();

    let error = Streams::copy_to_end_limited(&mut input, &mut output, 4)
        .expect_err("tail probe read errors should be returned");

    assert_eq!(ErrorKind::Other, error.kind());
    assert_eq!("tail read failed", error.to_string());
    assert_eq!(b"abcd", output.as_slice());
}

#[test]
fn test_copy_to_end_limited_method_rejects_oversized_input() {
    let mut input = Cursor::new(b"abcdef".to_vec());
    let mut output = Vec::new();

    let error = input
        .copy_to_end_limited(&mut output, 4)
        .expect_err("copy_to_end_limited method should reject oversized input");

    assert_eq!(ErrorKind::InvalidData, error.kind());
    assert_eq!(b"abcd", output.as_slice());
    assert_eq!(5, input.position());
}

#[test]
fn test_read_to_end_limited_returns_vec_when_input_fits() {
    let mut input = Cursor::new(b"abc".to_vec());

    let data = input
        .read_to_end_limited(3)
        .expect("input within limit should be read");

    assert_eq!(b"abc", data.as_slice());
}

#[test]
fn test_read_to_end_limited_rejects_input_beyond_limit() {
    let mut input = Cursor::new(b"abcd".to_vec());

    let error = input
        .read_to_end_limited(3)
        .expect_err("input beyond limit should fail");

    assert_eq!(ErrorKind::InvalidData, error.kind());
}

#[test]
fn test_content_eq_compares_streams() {
    let mut left = Cursor::new(b"abc".to_vec());
    let mut same = Cursor::new(b"abc".to_vec());

    assert!(
        Streams::content_eq(&mut left, &mut same)
            .expect("equal streams should compare")
    );

    let mut left = Cursor::new(b"abc".to_vec());
    let mut different = Cursor::new(b"abd".to_vec());

    assert!(
        !Streams::content_eq(&mut left, &mut different)
            .expect("different streams should compare")
    );
}

#[test]
fn test_content_eq_returns_read_error() {
    let mut left = FailingReader;
    let mut right = Cursor::new(b"abc".to_vec());

    let error = Streams::content_eq(&mut left, &mut right)
        .expect_err("content_eq should return compare read errors");

    assert_eq!(ErrorKind::Other, error.kind());
    assert_eq!("read failed", error.to_string());
}

#[test]
fn test_compare_content_returns_lexicographic_ordering() {
    let mut less = Cursor::new(b"abc".to_vec());
    let mut greater = Cursor::new(b"abd".to_vec());
    let mut prefix = Cursor::new(b"ab".to_vec());
    let mut full = Cursor::new(b"abc".to_vec());

    assert_eq!(
        Ordering::Less,
        Streams::compare_content(&mut less, &mut greater)
            .expect("streams should compare")
    );
    assert_eq!(
        Ordering::Less,
        Streams::compare_content(&mut prefix, &mut full)
            .expect("prefix should compare")
    );

    let mut full = Cursor::new(b"abc".to_vec());
    let mut prefix = Cursor::new(b"ab".to_vec());
    assert_eq!(
        Ordering::Greater,
        Streams::compare_content(&mut full, &mut prefix)
            .expect("full stream should compare")
    );

    let mut left = Cursor::new(b"abc".to_vec());
    let mut right = Cursor::new(b"abc".to_vec());
    assert_eq!(
        Ordering::Equal,
        Streams::compare_content(&mut left, &mut right)
            .expect("equal streams should compare")
    );
}

#[test]
fn test_compare_content_returns_left_read_error() {
    let mut left = FailingReader;
    let mut right = Cursor::new(b"abc".to_vec());

    let error = Streams::compare_content(&mut left, &mut right)
        .expect_err("left read errors should be returned");

    assert_eq!(ErrorKind::Other, error.kind());
    assert_eq!("read failed", error.to_string());
}

#[test]
fn test_compare_content_returns_right_read_error() {
    let mut left = Cursor::new(b"abc".to_vec());
    let mut right = FailingReader;

    let error = Streams::compare_content(&mut left, &mut right)
        .expect_err("right read errors should be returned");

    assert_eq!(ErrorKind::Other, error.kind());
    assert_eq!("read failed", error.to_string());
}