Struct BitBuffer 

pub struct BitBuffer { /* private fields */ }

An immutable bitset stored as a packed byte buffer.

Implementations

impl BitBuffer

pub fn new(buffer: ByteBuffer, len: usize) -> Self

Create a new BoolBuffer backed by a ByteBuffer with len bits in view.

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

pub fn new_with_offset(buffer: ByteBuffer, len: usize, offset: usize) -> Self

Create a new BoolBuffer backed by a ByteBuffer with len bits in view, starting at the given offset (in bits).

Panics if the buffer is not large enough to hold len bits or if the offset is greater than

pub fn new_set(len: usize) -> Self

Create a new BoolBuffer of length len where all bits are set (true).

pub fn new_unset(len: usize) -> Self

Create a new BoolBuffer of length len where all bits are unset (false).

pub fn empty() -> Self

Create a new empty BitBuffer.

pub fn full(value: bool, len: usize) -> Self

Create a new BitBuffer of length len where all bits are set to value.

pub fn collect_bool<F: FnMut(usize) -> bool>(len: usize, f: F) -> Self

Invokes f with indexes 0..len collecting the boolean results into a new BitBuffer

pub fn len(&self) -> usize

Get the logical length of this BoolBuffer.

This may differ from the physical length of the backing buffer, for example if it was created using the new_with_offset constructor, or if it was sliced.

pub fn is_empty(&self) -> bool

Returns true if the BoolBuffer is empty.

pub fn offset(&self) -> usize

Offset of the start of the buffer in bits.

pub fn inner(&self) -> &ByteBuffer

Get a reference to the underlying buffer.

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 buffer

pub fn slice(&self, range: Range<usize>) -> Self

Create a new zero-copy slice of this BoolBuffer that begins at the start index and extends for len bits.

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

pub fn shrink_offset(self) -> Self

Slice any full bytes from the buffer, leaving the offset < 8.

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

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

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

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

If you’re performing operations on a single buffer, prefer BitBuffer::unaligned_chunks

pub fn true_count(&self) -> usize

Get the number of set bits in the buffer.

pub fn false_count(&self) -> usize

Get the number of unset bits in the buffer.

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

Iterator over bits in the buffer

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

Iterator over set indices of the underlying buffer

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

Iterator over set slices of the underlying buffer

pub fn sliced(&self) -> Self

Created a new BitBuffer with offset reset to 0

impl BitBuffer

pub fn into_inner(self) -> ByteBuffer

Consumes this BoolBuffer and returns the backing Buffer<u8> with any offset and length information applied.

pub fn into_mut(self) -> BitBufferMut

Get a mutable version of this BitBuffer along with bit offset in the first byte.

If the caller doesn’t hold only reference to the underlying buffer, a copy is created. The second value of the tuple is a bit_offset of the first value in the first byte

Trait Implementations

impl BitAnd for &BitBuffer

type Output = BitBuffer

The resulting type after applying the & operator.

fn bitand(self, rhs: Self) -> Self::Output

Performs the & operation.

impl BitAnd for BitBuffer

type Output = BitBuffer

The resulting type after applying the & operator.

fn bitand(self, rhs: Self) -> Self::Output

Performs the & operation.

impl BitOr for &BitBuffer

type Output = BitBuffer

The resulting type after applying the | operator.

fn bitor(self, rhs: Self) -> Self::Output

Performs the | operation.

impl BitOr for BitBuffer

type Output = BitBuffer

The resulting type after applying the | operator.

fn bitor(self, rhs: Self) -> Self::Output

Performs the | operation.

impl BitXor for &BitBuffer

type Output = BitBuffer

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: Self) -> Self::Output

Performs the ^ operation.

impl BitXor for BitBuffer

type Output = BitBuffer

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: Self) -> Self::Output

Performs the ^ operation.

impl Clone for BitBuffer

fn clone(&self) -> BitBuffer

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BitBuffer

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

Formats the value using the given formatter.

impl From<&[bool]> for BitBuffer

fn from(value: &[bool]) -> Self

Converts to this type from the input type.

impl From<BitBuffer> for BooleanBuffer

fn from(value: BitBuffer) -> Self

Converts to this type from the input type.

impl From<BooleanBuffer> for BitBuffer

fn from(value: BooleanBuffer) -> Self

Converts to this type from the input type.

impl From<Vec<bool>> for BitBuffer

fn from(value: Vec<bool>) -> Self

Converts to this type from the input type.

impl FromIterator<bool> for BitBuffer

fn from_iter<T: IntoIterator<Item = bool>>(iter: T) -> Self

Creates a value from an iterator.

impl<'a> IntoIterator for &'a BitBuffer

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 Not for &BitBuffer

type Output = BitBuffer

The resulting type after applying the ! operator.

fn not(self) -> Self::Output

Performs the unary ! operation.

impl Not for BitBuffer

type Output = BitBuffer

The resulting type after applying the ! operator.

fn not(self) -> Self::Output

Performs the unary ! operation.

impl PartialEq for BitBuffer

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.

impl Eq for BitBuffer