#binary-data #magic #parser #macro #derive-macro #binary #parse #struct #read #data

binread

A Rust crate for helping read structs from binary data using ✨macro magic✨

11 stable releases

2.2.0 Aug 25, 2021
2.1.1 Apr 1, 2021
2.1.0 Mar 28, 2021
1.4.1 Nov 11, 2020
1.0.2 Jul 15, 2020

#176 in Rust patterns

Download history 11678/week @ 2022-08-17 14567/week @ 2022-08-24 11403/week @ 2022-08-31 13280/week @ 2022-09-07 15166/week @ 2022-09-14 15471/week @ 2022-09-21 12787/week @ 2022-09-28 13990/week @ 2022-10-05 14162/week @ 2022-10-12 12542/week @ 2022-10-19 11147/week @ 2022-10-26 12920/week @ 2022-11-02 12647/week @ 2022-11-09 9480/week @ 2022-11-16 7230/week @ 2022-11-23 9572/week @ 2022-11-30

41,137 downloads per month
Used in 98 crates (33 directly)

MIT license

115KB
2K SLoC

binread

tests docs.rs codecov discord matrix: #binrw:matrix.org

A Rust crate for helping parse structs from binary data using ✨macro magic✨

Usage

BinRead uses a derive macro for declaratively defining binary parsing methods for structs.

#[derive(BinRead)]
#[br(magic = b"DOG", assert(name.len() != 0))]
struct Dog {
    bone_pile_count: u8,

    #[br(big, count = bone_pile_count)]
    bone_piles: Vec<u16>,

    #[br(align_before = 0xA)]
    name: NullString
}

let mut reader = Cursor::new(b"DOG\x02\x00\x01\x00\x12\0\0Rudy\0");
let dog: Dog = reader.read_ne().unwrap();
assert_eq!(dog.bone_piles, &[0x1, 0x12]);
assert_eq!(dog.name.into_string(), "Rudy")

More documentation can be found here

Dependencies

~235–660KB
~16K SLoC