#bit #bits #bitstream

no-std 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.

11 releases

Uses old Rust 2015

0.3.8 Sep 5, 2023
0.3.7 Apr 26, 2023
0.3.6 Apr 3, 2022
0.3.5 Jan 6, 2022
0.1.0 Aug 9, 2016

#1 in #finally

Download history 6544/week @ 2023-10-31 6261/week @ 2023-11-07 6950/week @ 2023-11-14 5880/week @ 2023-11-21 6136/week @ 2023-11-28 4694/week @ 2023-12-05 4987/week @ 2023-12-12 4384/week @ 2023-12-19 2320/week @ 2023-12-26 5006/week @ 2024-01-02 5443/week @ 2024-01-09 4742/week @ 2024-01-16 4849/week @ 2024-01-23 4154/week @ 2024-01-30 4054/week @ 2024-02-06 3809/week @ 2024-02-13

17,699 downloads per month
Used in 60 crates (24 directly)

MIT/Apache

32KB
508 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