Crate bitbuffer

Tools for reading and writing data types of arbitrary bit length and might not be byte-aligned in the source data

The main way of reading the binary data is to first create a BitReadBuffer ,wrap it into a BitReadStream and then read from the stream.

Once you have a BitStream, there are 2 different approaches of reading data

• read primitives, Strings and byte arrays, using read_bool, read_int, read_float, read_bytes and read_string
• read any type implementing the BitRead or BitReadSized traits using read and read_sized
  • BitRead is for types that can be read without requiring any size info (e.g. null-terminal strings, floats, whole integers, etc)
  • BitReadSized is for types that require external sizing information to be read (fixed length strings, arbitrary length integers

The BitRead and BitReadSized traits can be used with #[derive] if all fields implement BitRead or BitReadSized.

For writing the data you wrap the output Vec into a BitWriteStream which can then be used in a manner similar to the BitReadStream

• write primitives, Strings and byte arrays, using write_bool, write_int, write_float, write_bytes and write_string
• write any type implementing the BitWrite or BitWriteSized traits using write and write_sized
  • BitWrite is for types that can be written without requiring any size info (e.g. null-terminal strings, floats, whole integers, etc)
  • BitWriteSized is for types that require external sizing information to be written (fixed length strings, arbitrary length integers

Just like the read counterparts, BitWrite and BitWriteSized traits can be used with #[derive] if all fields implement BitWrite or BitWriteSized.

Examples

use bitbuffer::{BitReadBuffer, LittleEndian, BitReadStream, BitRead, BitWrite, BitWriteStream};

#[derive(BitRead, BitWrite)]
struct ComplexType {
    first: u8,
    #[size = 15]
    second: u16,
    third: bool,
}

let bytes = vec![
    0b1011_0101, 0b0110_1010, 0b1010_1100, 0b1001_1001,
    0b1001_1001, 0b1001_1001, 0b1001_1001, 0b1110_0111
];
let buffer = BitReadBuffer::new(&bytes, LittleEndian);
let mut stream = BitReadStream::new(buffer);
let value: u8 = stream.read_int(7)?;
let complex: ComplexType = stream.read()?;

let mut write_bytes = vec![];
let mut write_stream = BitWriteStream::new(&mut write_bytes, LittleEndian);
write_stream.write_int(12, 7)?;
write_stream.write(&ComplexType {
    first: 55,
    second: 12,
    third: true
})?;

Modules

• num_traits
  A number of traits to help being generic over numbers

Structs

• BigEndian
  Marks the buffer or stream as big endian
• BitReadBuffer
  Buffer that allows reading integers of arbitrary bit length and non byte-aligned integers
• BitReadStream
  Stream that provides an easy way to iterate trough a BitBuffer
• BitWriteStream
  Stream that provides an a way to write non bit aligned adata
• LazyBitRead
  Struct that lazily reads it’s contents from the stream
• LazyBitReadSized
  Struct that lazily reads it’s contents from the stream
• LittleEndian
  Marks the buffer or stream as little endian

Enums

• BitError
  Errors that can be returned when trying to read from or write to a buffer

Traits

• BitRead
  Trait for types that can be read from a stream without requiring the size to be configured
• BitReadSized
  Trait for types that can be read from a stream, requiring the size to be configured
• BitWrite
  Trait for types that can be written to a stream without requiring the size to be configured
• BitWriteSized
  Trait for types that can be written to a stream, requiring the size to be configured
• Endianness
  Trait for specifying endianness of bit buffer

Functions

• bit_size_of
  Get the number of bits required to read a type from stream
• bit_size_of_sized
  Get the number of bits required to read a type from stream given an input size

Type Aliases

• Result
  Either the read bits in the requested format or a BitError

Derive Macros

• BitRead
  See the crate documentation for details
• BitReadSized
  See the crate documentation for details
• BitWrite
  See the crate documentation for details
• BitWriteSized
  See the crate documentation for details