dotnet-binary-io 0.1.0

Reads and writes buffers using the same encoding rules as .NET's `System.IO.BinaryWriter`.
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

use crate::*;
use pretty_hex::PrettyHex;

#[test]
fn basic_u8() {
    let mut r = BinaryReader::new(&[42, 43, 44]);
    let b = r.read_u8().unwrap();
    assert_eq!(b, 42);
    assert_eq!(r.data, &[43, 44]);
}

/// Not sure why you would ever test a zero-length read, but ok.
#[test]
fn read_cbytes_zero_len() {
    let mut r = BinaryReader::new(&[0x33, 0x44]);
    let _empty: [u8; 0] = r.read_cbytes().unwrap();
    assert_eq!(r.data, [0x33, 0x44]);
}

#[test]
fn read_cbytes_not_enough() {
    let mut r = BinaryReader::new(&[0x33, 0x44, 0x55]);
    assert_eq!(r.read_cbytes::<5>(), Err(BinaryReaderError::NeedsMoreData));
}

#[test]
fn read_cbytes_some() {
    let mut r = BinaryReader::new(&[0x33, 0x44, 0x55]);
    assert_eq!(r.read_cbytes(), Ok([0x33, 0x44]));
    assert_eq!(r.data, [0x55]);
}

#[test]
fn read_u8() {
    let mut r = BinaryReader::new(&[0x33, 0x44, 0x55]);
    assert_eq!(r.read_u8(), Ok(0x33));
    assert_eq!(r.data, [0x44, 0x55]);
}

#[test]
fn basic_u16() {
    let mut r = BinaryReader::new(&[]);
    assert_eq!(r.read_u16(), Err(BinaryReaderError::NeedsMoreData));

    let mut r = BinaryReader::new(&[0xaa, 0x55, 0x33, 0x44]);
    assert_eq!(r.read_u16(), Ok(0x55aa));
    assert_eq!(r.data, &[0x33, 0x44]);
}

#[test]
fn str_utf8() {
    let mut w = BinaryWriter::new();
    w.write_utf8_str("Hello!").unwrap();
    w.write_u16(0xaa55);
    assert_eq!(w.out, [6, b'H', b'e', b'l', b'l', b'o', b'!', 0x55, 0xaa]);

    let mut r = BinaryReader::new(&w.out);
    assert_eq!(r.read_utf8_bytes(), Ok(b"Hello!".as_slice()));
    assert_eq!(r.data, [0x55, 0xaa]);
}

#[test]
fn str_utf16() {
    let mut w = BinaryWriter::new();
    w.write_utf16_encode("Hello!");
}

#[test]
fn mixed() {
    let mut w = BinaryWriter::new();
    w.write_u8(42);
    w.write_u16(0x0102);
    w.write_utf8_str("Hello, world!").unwrap();
    w.write_i32(-33);

    println!("{}", w.out.hex_dump());

    let mut r = BinaryReader::new(&w.out);
    assert_eq!(r.read_u8(), Ok(42));
    assert_eq!(r.read_u16(), Ok(0x0102));
    assert_eq!(r.read_utf8_bytes(), Ok(b"Hello, world!".as_slice()));
    assert_eq!(r.read_i32(), Ok(-33));
}

#[test]
fn int7_i32() {
    let cases: &[(i32, &[u8])] = &[
        (0 /* 0x00000000 */, &[0x00]),
        (1 /* 0x00000001 */, &[0x01]),
        (-1 /* 0xffffffff */, &[0xff, 0xff, 0xff, 0xff, 0x0f]),
        (127 /* 0x0000007f */, &[0x7f]),
        (128 /* 0x00000080 */, &[0x80, 0x01]),
        (255 /* 0x000000ff */, &[0xff, 0x01]),
        (256 /* 0x00000100 */, &[0x80, 0x02]),
        (
            -12345, /* 0xffffcfc7 */
            &[0xc7, 0x9f, 0xff, 0xff, 0x0f],
        ),
        (12345 /* 0x00003039 */, &[0xb9, 0x60]),
        (
            2147483647, /* 0x7fffffff */
            &[0xff, 0xff, 0xff, 0xff, 0x07],
        ),
        (
            -2147483648, /* 0x80000000 */
            &[0x80, 0x80, 0x80, 0x80, 0x08],
        ),
    ];

    // Check encoding
    for &(x, bytes) in cases.iter() {
        let mut w = BinaryWriter::new();
        w.write_7bit_encoded_i32(x);
        assert_eq!(w.out, bytes, "x = {x} (0x{x:x})");
    }

    // Check decoding
    for &(expected_x, bytes) in cases.iter() {
        let mut r = BinaryReader::new(bytes);
        let decoded_x = r.read_7bit_encoded_i32().unwrap();
        assert_eq!(decoded_x, expected_x, "x = {expected_x} (0x{expected_x:x})");
    }
}

#[test]
fn int7_i64() {
    let cases: &[(i64, &[u8])] = &[
        (0 /* 0x00000000 */, &[0x00]),
        (1 /* 0x00000001 */, &[0x01]),
        (
            -1, /* 0xffffffffffffffff */
            &[0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0x01],
        ),
        (127 /* 0x0000007f */, &[0x7f]),
        (128 /* 0x00000080 */, &[0x80, 0x01]),
        (255 /* 0x000000ff */, &[0xff, 0x01]),
        (256 /* 0x00000100 */, &[0x80, 0x02]),
        (
            -12345, /* 0xffffffffffffcfc7 */
            &[0xc7, 0x9f, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0x01],
        ),
        (12345 /* 0x00003039 */, &[0xb9, 0x60]),
        (
            9223372036854775807, /* 0x7fffffffffffffff */
            &[0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0x7f],
        ),
        (
            -9223372036854775808, /* 0x8000000000000000 */
            &[0x80, 0x80, 0x80, 0x80, 0x80, 0x80, 0x80, 0x80, 0x80, 0x01],
        ),
    ];

    // Check encoding
    for &(x, bytes) in cases.iter() {
        let mut w = BinaryWriter::new();
        w.write_7bit_encoded_i64(x);
        assert_eq!(w.out, bytes, "x = {x} (0x{x:x})");
    }

    // Check decoding
    for &(expected_x, bytes) in cases.iter() {
        let mut r = BinaryReader::new(bytes);
        let decoded_x = r.read_7bit_encoded_i64().unwrap();
        assert_eq!(decoded_x, expected_x, "x = {expected_x} (0x{expected_x:x})");
    }
}