Gitiles
Code Review Sign In
android-review.linaro.org / platform / external / rust / crates / bitreader / 88037d191098d5b73501fdcd11b16055e74d0e69
commit88037d191098d5b73501fdcd11b16055e74d0e69[log] [tgz]
authorAndrew Walbran <qwandor@google.com>Wed Oct 18 16:43:05 2023 +0100
committerAndrew Walbran <qwandor@google.com>Wed Oct 18 16:43:05 2023 +0100
tree935b8af9ba613989a098688ec3ebb43d5737e071
parent282663bf5e8617f94955c67626a65fa223a0a1ec [diff]
Migrate to cargo_embargo.

Bug: 293289578
Test: Ran cargo_embargo, compared Android.bp
Change-Id: I7cd7e13636f91080f45a0e423f91657a5324a8b0
3 files changed
tree: 935b8af9ba613989a098688ec3ebb43d5737e071
  1. src/
  2. LICENSE ⇨ LICENSE-APACHE
  3. Android.bp
  4. Cargo.toml
  5. Cargo.toml.orig
  6. cargo_embargo.json
  7. LICENSE-APACHE
  8. METADATA
  9. MODULE_LICENSE_APACHE2
  10. OWNERS
  11. 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.