gecko-dev/third_party/rust/bitreader
Alfredo.Yang c178f4e8ec Bug 1343793 - update rust mp4parser. r=kinetik
MozReview-Commit-ID: GGfv911o5Rb

--HG--
rename : third_party/rust/bitreader/LICENSE => third_party/rust/bitreader/LICENSE-APACHE
extra : rebase_source : a60a623af8465fe2220c5294f60f43f75a8513ec
2017-03-07 09:30:48 +08:00
..
src Bug 1343793 - update rust mp4parser. r=kinetik 2017-03-07 09:30:48 +08:00
.cargo-checksum.json Bug 1343793 - update rust mp4parser. r=kinetik 2017-03-07 09:30:48 +08:00
.cargo-ok
.gitignore
.travis.yml
Cargo.toml Bug 1343793 - update rust mp4parser. r=kinetik 2017-03-07 09:30:48 +08:00
LICENSE-APACHE Bug 1343793 - update rust mp4parser. r=kinetik 2017-03-07 09:30:48 +08:00
LICENSE-MIT Bug 1343793 - update rust mp4parser. r=kinetik 2017-03-07 09:30:48 +08:00
README.md Bug 1343793 - update rust mp4parser. r=kinetik 2017-03-07 09:30:48 +08:00

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).

License

Licensed under the Apache License, Version 2.0 or the MIT license, at your option.