gecko-dev/third_party/rust/bitreader
Alfredo.Yang a455e9f1e7 Bug 1328221 - Support GASpecificConfig audio channel in rust mp4 parser. r=rillian
MozReview-Commit-ID: IQKxtjatU9J

--HG--
extra : rebase_source : d710f6f639415e1ff7d99b39a6ef97dfd65868e3
2017-01-11 09:03:30 +08:00
..
src
.cargo-checksum.json
.cargo-ok
.gitignore
.travis.yml
Cargo.toml
LICENSE
README.md

BitReader

BitReader is a helper type to extract strings of bits from a slice of bytes.

Published Package Documentation Build Status

Here is how you read first a single bit, then three bits and finally four bits from a byte buffer:

use bitreader::BitReader;

let slice_of_u8 = &[0b1000_1111];
let mut reader = BitReader::new(slice_of_u8);

// You obviously should use try! or some other error handling mechanism here
let a_single_bit = reader.read_u8(1).unwrap(); // 1
let more_bits = reader.read_u8(3).unwrap(); // 0
let last_bits_of_byte = reader.read_u8(4).unwrap(); // 0b1111

You can naturally read bits from longer buffer of data than just a single byte.

As you read bits, the internal cursor of BitReader moves on along the stream of bits. Little endian format is assumed when reading the multi-byte values. BitReader supports reading maximum of 64 bits at a time (with read_u64).