#bit #bits #bitstream

bitreader

BitReader helps reading individual bits from a slice of bytes. You can read "unusual" numbers of bits from the byte slice, for example 13 bits at once. The reader internally keeps track of position within the buffer.

9 releases

Uses old Rust 2015

0.3.6 Apr 3, 2022
0.3.5 Jan 6, 2022
0.3.4 May 23, 2021
0.3.3 Jan 24, 2021
0.1.0 Aug 9, 2016

#285 in Algorithms

Download history 3025/week @ 2022-10-08 3074/week @ 2022-10-15 3870/week @ 2022-10-22 4271/week @ 2022-10-29 4308/week @ 2022-11-05 3709/week @ 2022-11-12 3166/week @ 2022-11-19 3451/week @ 2022-11-26 3816/week @ 2022-12-03 3737/week @ 2022-12-10 3486/week @ 2022-12-17 2033/week @ 2022-12-24 3010/week @ 2022-12-31 4025/week @ 2023-01-07 3625/week @ 2023-01-14 3898/week @ 2023-01-21

14,793 downloads per month
Used in 50 crates (23 directly)

MIT/Apache

30KB
492 lines

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.

Dependencies