# bitread The bitread library in Rust is designed to efficiently convert small binary data into Rust structs. It requires users to specify the bit count for each field and supports both Lsb0 and Msb0 formats. The library is streamlined, offering only "bits" and "map" attributes. The core concept behind bitread is: - Reliability: It's built to work effectively. - Simplicity: Utilizing macro magic, it's easy to adapt for specific requirements. - Lightweight: It's a concise declarative macro built upon [bitvec](https://github.com/ferrilab/bitvec). This approach ensures bitread is both user-friendly and versatile, catering to a wide range of binary data handling needs in Rust programming. !Please note that the library currently does not support endianess; it defaults to using the system's local endianess. This is an important consideration when working with data that may have specific endian requirements. Example: ```rust use bitread::prelude::*; #[derive(BitRead, Debug, PartialEq)] #[bitrw(endian = "little", bit_order = "lsb")] pub struct PositionWithInactivityTimer { #[bitrw(bits = 1)] last_fix_failed: bool, #[bitrw( bits = 23, map = "|x: i32| { x as f64 * (180.0 / ((1 << 23) as f64)) }" )] latitude_degrees: f64, } fn main() { println!("Hello, world!"); let data = vec![ 0xE8, // Last fix failed (0), 23 bit latitude (remaining bits) 0x25, // 23 bit latitude (continued) 0xF4, // 23 bit latitude (continued) ]; let position_with_inactivity_timer = PositionWithInactivityTimer::read_from(data.as_slice()).unwrap(); assert_eq!( position_with_inactivity_timer, PositionWithInactivityTimer { last_fix_failed: false, latitude_degrees: -8.33338737487793, } ); } ``` ## Other libraries If you need write capabilities too and more features, you should check following libs: [Deku](https://github.com/sharksforarms/deku): Deku is a Rust library designed for reading and writing binary data. It's particularly useful for parsing data structures in binary formats. The library's macro system simplifies the definition of data structures and provides an easy-to-use interface for serializing and deserializing data. Its documentation and examples can be found at Deku GitHub Repository. [Binrw](https://github.com/jam1garner/binrw): Binrw is another Rust library focused on binary data serialization and deserialization. It stands out for its ease of use and flexibility, allowing developers to easily define how data structures are read from and written to binary formats. The library supports various data types and offers customization options for complex use cases. More information, including usage examples, is available at Binrw GitHub Repository. Both libraries are well-suited for projects that require detailed control over binary data processing, offering a combination of performance and ease of use.