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
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

#[test]
fn null_wide_strings() {
    use binrw::{io::Cursor, BinReaderExt, NullWideString};

    assert_eq!(
        Cursor::new(b"w\0i\0d\0e\0 \0s\0t\0r\0i\0n\0g\0s\0\0\0")
            .read_le::<NullWideString>()
            .unwrap()
            .to_string(),
        "wide strings"
    );

    assert_eq!(
        Cursor::new(b"\0a\0r\0e\0 \0e\0n\0d\0i\0a\0n\0 \0d\0e\0p\0e\0n\0d\0e\0n\0t\0\0")
            .read_be::<NullWideString>()
            .unwrap()
            .to_string(),
        "are endian dependent"
    );

    assert_eq!(
        format!(
            "{:?}",
            Cursor::new(b"d\0e\0b\0u\0g\0\x3a\x26\n\0\0\0")
                .read_le::<NullWideString>()
                .unwrap()
        ),
        "NullWideString(\"debug☺\\n\")"
    );

    assert_eq!(
        format!(
            "{:?}",
            Cursor::new(b"b\0a\0d\0 \0\0\xdc\0\xdc \0s\0u\0r\0r\0o\0g\0a\0t\0e\0\0\0")
                .read_le::<NullWideString>()
                .unwrap()
        ),
        "NullWideString(\"bad \u{FFFD}\u{FFFD} surrogate\")"
    );

    // Default/Deref/DerefMut
    let mut s = NullWideString::default();
    s.extend_from_slice(&[b'h'.into(), b'e'.into(), b'y'.into()]);
    assert_eq!(&s[0..2], &[b'h'.into(), b'e'.into()]);

    // Clone/TryFrom
    let t = String::try_from(s.clone()).unwrap();
    assert_eq!(t, "hey");
    s.push(0xdc00);
    String::try_from(s).expect_err("accepted bad data");

    // From
    let s = NullWideString::from(t.clone());
    assert_eq!(Vec::from(s), t.encode_utf16().collect::<Vec<_>>());
}

#[test]
fn null_strings() {
    use binrw::{io::Cursor, BinReaderExt, NullString};

    let mut null_separated_strings =
        Cursor::new(b"null terminated strings? in my system's language?\0no thanks\0");

    assert_eq!(
        null_separated_strings
            .read_be::<NullString>()
            .unwrap()
            .to_string(),
        "null terminated strings? in my system's language?"
    );

    assert_eq!(
        null_separated_strings
            .read_be::<NullString>()
            .unwrap()
            .to_string(),
        "no thanks"
    );

    assert_eq!(
        format!(
            "{:?}",
            Cursor::new(b"debug\xe2\x98\xba\n\0")
                .read_be::<NullString>()
                .unwrap()
        ),
        "NullString(\"debug☺\\n\")"
    );

    assert_eq!(
        format!(
            "{:?}",
            Cursor::new(b"bad \xfe utf8 \xfe\0")
                .read_be::<NullString>()
                .unwrap()
        ),
        "NullString(\"bad \u{FFFD} utf8 \u{FFFD}\")"
    );

    assert_eq!(
        format!(
            "{:?}",
            Cursor::new(b"truncated\xe2\0")
                .read_be::<NullString>()
                .unwrap()
        ),
        "NullString(\"truncated\u{FFFD}\")"
    );

    // Default/Deref/DerefMut
    let mut s = NullString::default();
    s.extend_from_slice(b"hey");
    assert_eq!(&s[0..2], b"he");

    // Clone/TryFrom
    let t = String::try_from(s.clone()).unwrap();
    assert_eq!(t, "hey");
    s.extend_from_slice(b"\xe2");
    String::try_from(s).expect_err("accepted bad data");

    // From
    let s = NullString::from(t.clone());
    assert_eq!(Vec::from(s), t.as_bytes());
}

#[test]
fn null_string_round_trip() {
    use binrw::{io::Cursor, BinReaderExt, BinWriterExt, NullString};

    let data = "test test test";
    let s = NullString::from(data);

    let mut x = Cursor::new(Vec::new());
    x.write_be(&s).unwrap();

    let s2: NullString = Cursor::new(x.into_inner()).read_be().unwrap();

    assert_eq!(&s2.to_string(), data);
}

#[test]
fn null_wide_string_round_trip() {
    use binrw::{io::Cursor, BinReaderExt, BinWriterExt, NullWideString};

    let data = "test test test";
    let s = NullWideString::from(data);

    let mut x = Cursor::new(Vec::new());
    x.write_be(&s).unwrap();

    let s2: NullWideString = Cursor::new(x.into_inner()).read_be().unwrap();

    assert_eq!(&s2.to_string(), data);
}