tag	6d7522dec73d2c0582c1612ada20a764a1ca343a
tagger	Xin Li <delphij@google.com>	Wed Apr 24 19:37:48 2024 -0700
object	9141824f65070190404131dbfdbf90be982fbe9b

commit	9141824f65070190404131dbfdbf90be982fbe9b	[log] [tgz]
author	Android Build Coastguard Worker <android-build-coastguard-worker@google.com>	Sat Jul 08 04:31:18 2023 +0000
committer	Android Build Coastguard Worker <android-build-coastguard-worker@google.com>	Sat Jul 08 04:31:18 2023 +0000
tree	7442a329d612499cdc5be0c9b778eae0c2dc76d4
parent	8663848e053735efd6fd320a87da193014ec2dec [diff]
parent	716f98e399780802432a6f44e9f562c2d82fe628 [diff]

tree: 7442a329d612499cdc5be0c9b778eae0c2dc76d4

README.md

BitReader

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

License

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