commit | febd9113be0f98e8c704a557d94fe180b161145e | [log] [tgz] |
---|---|---|
author | Andrew Walbran <qwandor@google.com> | Mon Aug 05 17:50:41 2024 +0000 |
committer | Automerger Merge Worker <android-build-automerger-merge-worker@system.gserviceaccount.com> | Mon Aug 05 17:50:41 2024 +0000 |
tree | ffb83a43f8d33665c862fd957397b2e0a0d3ad5d | |
parent | a3c44c045f550eff568d508e40a338cbceb7293b [diff] | |
parent | a54d90d489d8f04c66ac99447b8ce2de4975fec0 [diff] |
Generate license header with cargo_embargo. am: a54d90d489 Original change: https://android-review.googlesource.com/c/platform/external/rust/crates/bitreader/+/3205764 Change-Id: Ie95ce8fbf83f6c99fa50abd648585d79238e0962 Signed-off-by: Automerger Merge Worker <android-build-automerger-merge-worker@system.gserviceaccount.com>
BitReader is a helper type to extract strings of bits from a slice of bytes.
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).
Licensed under the Apache License, Version 2.0 or the MIT license, at your option.