#binary-parser #binary-data #structs #macro-derive #read #helping #methods

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

#513 in Rust patterns

Download history 13419/week @ 2024-11-15 13928/week @ 2024-11-22 13665/week @ 2024-11-29 15453/week @ 2024-12-06 13443/week @ 2024-12-13 5978/week @ 2024-12-20 4619/week @ 2024-12-27 14273/week @ 2025-01-03 14630/week @ 2025-01-10 16039/week @ 2025-01-17 14456/week @ 2025-01-24 16536/week @ 2025-01-31 15684/week @ 2025-02-07 12191/week @ 2025-02-14 15329/week @ 2025-02-21 13408/week @ 2025-02-28

59,886 downloads per month
Used in 284 crates (35 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

~1.5MB
~39K SLoC