commit	34c8e34910b6f88cb6d55b294ee12bd18a611ab2	[log] [tgz]
author	Bob Badour <bbadour@google.com>	Fri Nov 11 08:14:33 2022 +0000
committer	Automerger Merge Worker <android-build-automerger-merge-worker@system.gserviceaccount.com>	Fri Nov 11 08:14:33 2022 +0000
tree	0315c43dc2764a132e7916559c45799800926c81
parent	fb7ce059b4ca2fee584cb91f60dfa5ad2c9c8d5e [diff]
parent	db3b91f608546bbb2179d2ae0254666eedbaff97 [diff]

tree: 0315c43dc2764a132e7916559c45799800926c81

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.