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

use binrw::{binrw, io::Cursor, BinWrite};

#[test]
fn correct_args_type_set() {
    #[derive(BinWrite)]
    #[bw(import { _x: u32, _y: u8 })]
    struct Test {}

    let mut x = Cursor::new(Vec::new());

    Test {}
        .write_le_args(&mut x, binrw::args! { _x: 3, _y: 2 })
        .unwrap();
}

#[test]
fn gat_list() {
    #[derive(BinWrite)]
    #[bw(little, import(borrowed: &u8))]
    struct Test {
        #[bw(map = |a| *a + *borrowed)]
        a: u8,
    }

    let mut out = Cursor::new(Vec::new());
    Test { a: 0 }.write_args(&mut out, (&1_u8,)).unwrap();

    assert_eq!(out.into_inner(), b"\x01");
}

#[test]
fn gat_named() {
    #[derive(BinWrite)]
    #[bw(little, import { borrowed: &u8 })]
    struct Test {
        #[bw(map = |a| *a + *borrowed)]
        a: u8,
    }

    let mut out = Cursor::new(Vec::new());
    Test { a: 0 }
        .write_args(&mut out, binrw::args! { borrowed: &1_u8, })
        .unwrap();

    assert_eq!(out.into_inner(), b"\x01");
}

#[test]
fn gat_raw() {
    #[derive(BinWrite)]
    #[bw(little, import_raw(borrowed: &u8))]
    struct Test {
        #[bw(map = |a| *a + *borrowed)]
        a: u8,
    }

    let mut out = Cursor::new(Vec::new());
    Test { a: 0 }.write_args(&mut out, &1_u8).unwrap();

    assert_eq!(out.into_inner(), b"\x01");
}

#[test]
fn shadowed_imports() {
    #[derive(BinWrite)]
    #[bw(import { x: u32 })]
    struct Test {
        x: u8,
    }

    let mut out = Cursor::new(Vec::new());
    Test { x: 1 }
        .write_le_args(&mut out, binrw::args! { x: 2 })
        .unwrap();
    assert_eq!(out.into_inner(), b"\x01");
}

#[test]
fn usable_args() {
    #[binrw]
    #[bw(import { x: u32, _y: u8 })]
    struct Test {
        #[br(temp, ignore)]
        #[bw(calc = x)]
        x_copy: u32,
    }

    let mut x = Cursor::new(Vec::new());

    Test {}
        .write_le_args(&mut x, binrw::args! { x: 3, _y: 2 })
        .unwrap();
}