Struct BitBufferMutView 

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

A mutable, borrowed view over a packed bitset.

This is the borrowing analogue of BitBufferMut: it stores a mutable byte slice together with a bit offset (always < 8) and a logical bit len. Unlike BitBufferMut it cannot grow or reallocate, so it only supports in-place reads and writes (such as set, unset, and fill_range).

Implementations

impl<'a> BitBufferMutView<'a>

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

Create a new mutable 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 mut [u8], len: usize, offset: usize) -> Self

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

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

pub fn as_view(&self) -> BitBufferView<'_>

Borrow this mutable view as an immutable BitBufferView.

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 as_slice(&self) -> &[u8]

Get the underlying bytes as a slice.

pub fn as_mut_slice(&mut self) -> &mut [u8]

Get the underlying bytes as a mutable 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 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 iter(&self) -> BitIterator<'_>

Iterator over bits in the view.

pub fn set_to(&mut self, index: usize, value: bool)

Set the bit at index to the given boolean value.

Panics if index exceeds the view length.

pub unsafe fn set_to_unchecked(&mut self, index: usize, value: bool)

Set the bit at index to the given boolean value without bounds checking.

Safety

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

pub fn set(&mut self, index: usize)

Set the bit at index to true.

Panics if index exceeds the view length.

pub fn unset(&mut self, index: usize)

Set the bit at index to false.

Panics if index exceeds the view length.

pub unsafe fn set_unchecked(&mut self, index: usize)

Set the bit at index to true without bounds checking.

Safety

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

pub unsafe fn unset_unchecked(&mut self, index: usize)

Set the bit at index to false without bounds checking.

Safety

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

pub fn fill_range(&mut self, start: usize, end: usize, value: bool)

Sets all bits in the range [start, end) to value.

Panics if end > self.len() or start > end.

pub unsafe fn fill_range_unchecked( &mut self, start: usize, end: usize, value: bool, )

Sets all bits in the range [start, end) to value without bounds checking.

Safety

Caller must ensure that start <= end <= self.len().

pub fn to_bit_buffer(&self) -> BitBuffer

Copy this view into an owned BitBuffer.

Trait Implementations

impl<'a> Debug for BitBufferMutView<'a>

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

Formats the value using the given formatter.