Struct BitChunks

pub struct BitChunks<'a> {
    buffer: &'a [u8],
    bit_offset: usize,
    chunk_len: usize,
    remainder_len: usize,
}

Iterates over an arbitrarily aligned byte buffer

Yields an iterator of u64, and a remainder. The first byte in the buffer will be the least significant byte in output u64

Fields

buffer: &'a [u8]

bit_offset: usize

offset inside a byte, guaranteed to be between 0 and 7 (inclusive)

chunk_len: usize

number of complete u64 chunks

remainder_len: usize

number of remaining bits, guaranteed to be between 0 and 63 (inclusive)

Implementations

impl<'a> BitChunks<'a>

pub fn new(buffer: &'a [u8], offset: usize, len: usize) -> Self

Create a new BitChunks from a byte array, and an offset and length in bits

impl<'a> BitChunks<'a>

pub const fn remainder_len(&self) -> usize

Returns the number of remaining bits, guaranteed to be between 0 and 63 (inclusive)

pub const fn chunk_len(&self) -> usize

Returns the number of chunks

pub fn remainder_bits(&self) -> u64

Returns the bitmask of remaining bits

pub const fn iter(&self) -> BitChunkIterator<'a>

Returns an iterator over chunks of 64 bits represented as an u64

pub fn iter_padded(&self) -> impl Iterator<Item = u64> + 'a

Returns an iterator over chunks of 64 bits, with the remaining bits zero padded to 64-bits

Trait Implementations

impl<'a> Debug for BitChunks<'a>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'a> IntoIterator for BitChunks<'a>

type Item = u64

The type of the elements being iterated over.

type IntoIter = BitChunkIterator<'a>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.