qubit-io 0.4.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

use std::io::{
    Error,
    ErrorKind,
    Write,
};

use qubit_io::{
    BinaryWriteExt,
    ByteOrder,
};

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(())
    }
}

macro_rules! assert_write_ordered_integer {
    ($method:ident, $be:ident, $le:ident, $ty:ty, $value:expr) => {{
        let value: $ty = $value;
        let mut output = Vec::new();
        output.$method(value, ByteOrder::BigEndian).expect("runtime BE write");
        assert_eq!(value.to_be_bytes().as_slice(), output.as_slice());
        let mut output = Vec::new();
        output
            .$method(value, ByteOrder::LittleEndian)
            .expect("runtime LE write");
        assert_eq!(value.to_le_bytes().as_slice(), output.as_slice());
        let mut output = Vec::new();
        output.$be(value).expect("fixed BE write");
        assert_eq!(value.to_be_bytes().as_slice(), output.as_slice());
        let mut output = Vec::new();
        output.$le(value).expect("fixed LE write");
        assert_eq!(value.to_le_bytes().as_slice(), output.as_slice());
    }};
}

macro_rules! assert_write_ordered_float {
    ($method:ident, $be:ident, $le:ident, $ty:ty, $value:expr) => {{
        let value: $ty = $value;
        let mut output = Vec::new();
        output.$method(value, ByteOrder::BigEndian).expect("runtime BE write");
        assert_eq!(value.to_bits().to_be_bytes().as_slice(), output.as_slice());
        let mut output = Vec::new();
        output
            .$method(value, ByteOrder::LittleEndian)
            .expect("runtime LE write");
        assert_eq!(value.to_bits().to_le_bytes().as_slice(), output.as_slice());
        let mut output = Vec::new();
        output.$be(value).expect("fixed BE write");
        assert_eq!(value.to_bits().to_be_bytes().as_slice(), output.as_slice());
        let mut output = Vec::new();
        output.$le(value).expect("fixed LE write");
        assert_eq!(value.to_bits().to_le_bytes().as_slice(), output.as_slice());
    }};
}

#[test]
fn test_binary_write_ext_writes_all_scalar_methods() {
    let mut output = Vec::new();
    output.write_u8(0x12).expect("u8 should be written");
    output.write_i8(-2).expect("i8 should be written");
    assert_eq!(vec![0x12, 0xfe], output);

    assert_write_ordered_integer!(write_u16, write_u16_be, write_u16_le, u16, 0x1234);
    assert_write_ordered_integer!(write_u32, write_u32_be, write_u32_le, u32, 0x1234_5678);
    assert_write_ordered_integer!(write_u64, write_u64_be, write_u64_le, u64, 0x0123_4567_89ab_cdef);
    assert_write_ordered_integer!(
        write_u128,
        write_u128_be,
        write_u128_le,
        u128,
        0x0123_4567_89ab_cdef_fedc_ba98_7654_3210
    );
    assert_write_ordered_integer!(write_i16, write_i16_be, write_i16_le, i16, -0x1234);
    assert_write_ordered_integer!(write_i32, write_i32_be, write_i32_le, i32, -0x0123_4567);
    assert_write_ordered_integer!(write_i64, write_i64_be, write_i64_le, i64, -0x0123_4567_89ab_cdef);
    assert_write_ordered_integer!(
        write_i128,
        write_i128_be,
        write_i128_le,
        i128,
        -0x0123_4567_89ab_cdef_fedc_ba98_7654_3210
    );
    assert_write_ordered_float!(write_f32, write_f32_be, write_f32_le, f32, 12.5);
    assert_write_ordered_float!(write_f64, write_f64_be, write_f64_le, f64, -25.25);
}

#[test]
fn test_binary_write_ext_reports_errors() {
    let mut writer = FailingWriter;
    assert_eq!(
        ErrorKind::Other,
        writer.write_u16_be(0x1234).expect_err("write should fail").kind()
    );
}