#magic #big #little #derive #vec

binwrite

A Rust crate for helping write structs as binary data using ✨macro magic✨

8 releases

0.2.1 Feb 7, 2020
0.2.0 Feb 7, 2020
0.1.5 Dec 11, 2019
0.1.3 Nov 3, 2019

#1817 in Encoding

Download history 916/week @ 2024-12-08 749/week @ 2024-12-15 625/week @ 2024-12-22 309/week @ 2024-12-29 564/week @ 2025-01-05 443/week @ 2025-01-12 476/week @ 2025-01-19 401/week @ 2025-01-26 398/week @ 2025-02-02 330/week @ 2025-02-09 261/week @ 2025-02-16 346/week @ 2025-02-23 247/week @ 2025-03-02 261/week @ 2025-03-09 292/week @ 2025-03-16 251/week @ 2025-03-23

1,092 downloads per month
Used in 21 crates (13 directly)

MIT license

19KB
225 lines

binwrite

A Rust crate for helping write structs as binary data using ✨macro magic✨

Usage

BinWrite uses a derive macro for declaratively defining binary writing methods for structs.

Basic Example

use binwrite::BinWrite;

#[derive(BinWrite)]
#[binwrite(little)]
struct Rect {
    x: i32,
    y: i32,
    #[binwrite(big)]
    size: (u16, u16),
}

fn main() {
    let rects = vec![
        Rect { x: 1, y: -2, size: (3, 4) },
        Rect { x: 20, y: 4, size: (5, 7) }
    ];
    let mut bytes = vec![];
    rects.write(&mut bytes).unwrap();
    assert_eq!(
        bytes,
        vec![
        //  [  x (little endian) ]  [  y (little endian) ]  [ size.0 ]  [ size.1 ]
            0x01, 0x00, 0x00, 0x00, 0xFE, 0xFF, 0xFF, 0xFF, 0x00, 0x03, 0x00, 0x04,
            0x14, 0x00, 0x00, 0x00, 0x04, 0x00, 0x00, 0x00, 0x00, 0x05, 0x00, 0x07,
        ]
    );
}

more examples can be found in the BinWrite documentation.

Dependencies

~1.5MB
~38K SLoC