Make bitreader available to product and vendor am: e192529ed8 am: 7642b746a0 am: 0fb946a07f am: 5129762bc2

Original change: https://android-review.googlesource.com/c/platform/external/rust/crates/bitreader/+/2476080

Change-Id: I2a4e464f2386efa1a11355e210f5bf3712a82431
Signed-off-by: Automerger Merge Worker <android-build-automerger-merge-worker@system.gserviceaccount.com>
tree: 7442a329d612499cdc5be0c9b778eae0c2dc76d4
  1. src/
  2. Android.bp
  3. Cargo.toml
  4. Cargo.toml.orig
  5. cargo2android.json
  6. LICENSE-APACHE
  7. METADATA
  8. MODULE_LICENSE_APACHE2
  9. OWNERS
  10. README.md
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. Big 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.