Crate bitstream_io

Traits and helpers for bitstream handling functionality

Bitstream readers are for reading signed and unsigned integer values from a stream whose sizes may not be whole bytes. Bitstream writers are for writing signed and unsigned integer values to a stream, also potentially un-aligned at a whole byte.

Both big-endian and little-endian streams are supported.

The only requirement for wrapped reader streams is that they must implement the Read trait, and the only requirement for writer streams is that they must implement the Write trait.

In addition, reader streams do not consume any more bytes from the underlying reader than necessary, buffering only a single partial byte as needed. Writer streams also write out all whole bytes as they are accumulated.

Readers and writers are also designed to work with integer types of any possible size. Many of Rust’s built-in integer types are supported by default.

Re-exports

pub use read::BitReader;

pub use write::BitWriter;

Modules

huffman

Traits and implementations for reading or writing Huffman codes from or to a stream.

read

Traits and implementations for reading bits from a stream.

write

Traits and implementations for writing bits to a stream.

Structs

BigEndian

Big-endian, or most significant bits first

BitQueue

A queue for efficiently pushing bits onto a value and popping them off a value.

LittleEndian

Little-endian, or least significant bits first

Traits

Endianness

A stream’s endianness, or byte order, for determining how bits should be read.

Numeric

This trait extends many common integer types (both unsigned and signed) with a few trivial methods so that they can be used with the bitstream handling traits.

SignedNumeric

This trait extends many common signed integer types so that they can be used with the bitstream handling traits.

Type Definitions

BE

Big-endian, or most significant bits first

LE

Little-endian, or least significant bits first