Struct BitView 

pub struct BitView<'a, const NB: usize> { /* private fields */ }

A borrowed fixed-size mask of length N bits.

Since const generic expressions are not yet stable, we instead define the type over the number of bytes NB, and compute N as NB * 8.

This struct is designed to provide a view over a Vortex BitBuffer, therefore the bit-ordering is LSB0 (least-significant-bit first).

Note that BitView does not support an offset. Therefore, bits are assumed to start at index and end at index N - 1.

Implementations

impl<const NB: usize> BitView<'static, NB>

pub const fn all_true() -> Self

Creates a BitView with all bits set to true.

pub const fn all_false() -> Self

Creates a BitView with all bits set to false.

impl<'a, const NB: usize> BitView<'a, NB>

pub fn new(bits: &'a [u8; NB]) -> Self

Creates a BitView from raw bits, computing the true count.

pub fn new_owned(bits: [u8; NB]) -> Self

Creates a BitView from owned raw bits.

pub fn from_slice(bits: &'a [u8]) -> Self

Creates a BitView from a byte slice.

Panics

If the length of the slice is not equal to NB.

pub fn with_prefix(n_true: usize) -> Self

Creates a BitView from a mutable byte array, populating it with the requested prefix of true bits.

pub fn true_count(&self) -> usize

Returns the number of true bits in the view.

pub fn iter_ones<F>(&self, f: F)

where F: FnMut(usize),

Runs the provided function f for each index of a true bit in the view.

pub fn try_iter_ones<F>(&self, f: F) -> VortexResult<()>

where F: FnMut(usize) -> VortexResult<()>,

Runs the provided function f for each index of a true bit in the view.

pub fn iter_zeros<F>(&self, f: F)

where F: FnMut(usize),

Runs the provided function f for each index of a true bit in the view.

pub fn iter_slices<F>(&self, f: F)

where F: FnMut(BitSlice),

Runs the provided function f for each range of true bits in the view.

The function f receives a BitSlice containing the inclusive start bit as well as the length.

FIXME(ngates): this is still broken.

pub fn as_raw(&self) -> &[u8; NB]

Returns the raw bits of the view.

Trait Implementations

impl<const NB: usize> Debug for BitView<'_, NB>

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

Formats the value using the given formatter.