binrw 0.15.1

A Rust crate for helping read structs from binary data using ✨macro magic✨
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

extern crate alloc;

use alloc::format;
use binrw::{io::Cursor, punctuated::Punctuated, BinRead, BinReaderExt};

#[derive(BinRead, Clone, Copy, Debug)]
#[br(magic = 1u8)]
struct One;

#[derive(BinRead, Clone, Copy, Debug)]
#[br(magic = 2u8)]
struct Two;

#[derive(BinRead)]
struct PunctuatedTest {
    count: u8,

    #[br(count = count)]
    #[br(parse_with = Punctuated::<One, Two>::separated)]
    list: Punctuated<One, Two>,
}

#[derive(BinRead)]
struct PunctuatedTestTrailing {
    count: u8,

    #[br(count = count)]
    #[br(parse_with = Punctuated::<One, Two>::separated_trailing)]
    list: Punctuated<One, Two>,
}

// TODO: move to UI tests?
// #[derive(BinRead)]
// struct MissingCount {
//     #[br(parse_with = Punctuated::separated)]
//     _list: Punctuated<One, Two>,
// }
//
// #[derive(BinRead)]
// struct MissingCountTrailing {
//     #[br(parse_with = Punctuated::separated_trailing)]
//     _list: Punctuated<One, Two>,
// }

const TEST_DATA: &[u8] = b"\x03\x01\x02\x01\x02\x01";
const TEST_DATA_TRAILING: &[u8] = b"\x03\x01\x02\x01\x02\x01\x02";

#[test]
fn punctuated() {
    let mut x = Cursor::new(TEST_DATA);

    let y: PunctuatedTest = x.read_be().unwrap();

    assert_eq!(y.count, 3);
    assert_eq!(y.list.len(), 3);

    // This behavior may be reworked later
    assert_eq!(format!("{:?}", y.list), "[One, One, One]");
    assert_eq!(format!("{:?}", y.list.into_values()), "[One, One, One]");
}

#[test]
fn punctuated_trailing() {
    let mut x = Cursor::new(TEST_DATA_TRAILING);

    let mut y: PunctuatedTestTrailing = x.read_be().unwrap();

    assert_eq!(y.count, 3);
    assert_eq!(y.list.len(), 3);

    // DerefMut test
    let y = &mut *y.list;
    y[0] = y[1];
}

// TODO: move to UI tests?
// #[test]
// #[should_panic]
// fn missing_count() {
//     let mut x = Cursor::new(TEST_DATA);
//
//     let _: MissingCount = x.read_be().unwrap();
// }
//
// #[test]
// #[should_panic]
// fn missing_count_trailing() {
//     let mut x = Cursor::new(TEST_DATA);
//
//     let _: MissingCountTrailing = x.read_be().unwrap();
// }