Migrate 25 crates to monorepo

async-stream
async-stream-impl
async-task
async-trait
atomic
atty
axum
bencher
bincode
bitreader
bstr
buddy_system_allocator
byteorder
bytes
camino
cast
cesu8
cexpr
cfg-if
ciborium
ciborium-io
ciborium-ll
clap_complete
clap_derive
clap_lex

Bug: 339424309
Test: treehugger
Change-Id: I12f6b3ed8f3ab0025acead9d4cd77e6a4b405517
2 files changed
tree: 1c8eccc36849e2176abb7483e40b791c3bceb6fe
  1. .github/
  2. src/
  3. .cargo_vcs_info.json
  4. .gitignore
  5. Android.bp
  6. Cargo.toml
  7. Cargo.toml.orig
  8. LICENSE-APACHE
  9. LICENSE-MIT
  10. METADATA
  11. MODULE_LICENSE_APACHE2
  12. OWNERS
  13. 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.