Struct BitBufferView 

pub struct BitBufferView<'a> { /* private fields */ }

An immutable, borrowed view over a packed bitset.

This is the borrowing analogue of BitBuffer: it stores a byte slice together with a bit offset (always < 8) and a logical bit len, without owning or reference-counting the backing allocation. Use it to read a bitset without cloning the underlying ByteBuffer.

Implementations

impl<'a> BitBufferView<'a>

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

Create a new view over buffer with len bits, starting at bit zero.

Panics if the buffer is not large enough to hold len bits.

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

Create a new view over buffer with len bits, starting at the given bit offset.

Panics if the buffer is not large enough to hold len bits after the offset.

pub fn from_meta(buffer: &'a [u8], meta: BitBufferMeta) -> Self

Create a new view over buffer described by meta.

pub fn meta(&self) -> BitBufferMeta

Returns the BitBufferMeta (offset and length) describing this view.

pub fn len(&self) -> usize

Get the logical length of this view in bits.

pub fn is_empty(&self) -> bool

Returns true if the view is empty.

pub fn offset(&self) -> usize

Offset of the start of the view in bits. Always < 8.

pub fn inner(&self) -> &'a [u8]

Get a reference to the underlying byte slice.

pub fn value(&self, index: usize) -> bool

Retrieve the value at the given index.

Panics if the index is out of bounds.

pub unsafe fn value_unchecked(&self, index: usize) -> bool

Retrieve the value at the given index without bounds checking.

Safety

Caller must ensure that index is within the range of the view.

pub fn slice(&self, range: impl RangeBounds<usize>) -> BitBufferView<'a>

Create a new view over the range [start, end) of this view.

Panics if the slice would extend beyond the end of the view.

pub fn unaligned_chunks(&self) -> UnalignedBitChunk<'a>

Access chunks of the buffer aligned to an 8 byte boundary as [prefix, <full chunks>, suffix].

pub fn chunks(&self) -> BitChunks<'a>

Access chunks of the underlying buffer as 8 byte chunks with a final trailer.

pub fn true_count(&self) -> usize

Get the number of set bits in the view.

pub fn false_count(&self) -> usize

Get the number of unset bits in the view.

pub fn select(&self, nth: usize) -> Option<usize>

Returns the position of the nth set bit (0-indexed), or None if out of range.

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

Iterator over bits in the view.

pub fn set_indices(&self) -> BitIndexIterator<'a>

Iterator over set indices of the underlying buffer.

pub fn set_slices(&self) -> BitSliceIterator<'a>

Iterator over set slices of the underlying buffer.

pub fn to_bit_buffer(&self) -> BitBuffer

Copy this view into an owned BitBuffer.

Trait Implementations

impl<'a> Clone for BitBufferView<'a>

fn clone(&self) -> BitBufferView<'a>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'a> Copy for BitBufferView<'a>

impl<'a> Debug for BitBufferView<'a>

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

Formats the value using the given formatter.

impl Eq for BitBufferView<'_>

impl<'a> IntoIterator for BitBufferView<'a>

type Item = bool

The type of the elements being iterated over.

type IntoIter = BitIterator<'a>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl PartialEq for BitBufferView<'_>

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.