Struct BitBufferMut 

pub struct BitBufferMut { /* private fields */ }

A mutable bitset buffer that allows random access to individual bits for set and get.

Example

use vortex_buffer::BitBufferMut;

let mut bools = BitBufferMut::new_unset(10);
bools.set_to(9, true);
for i in 0..9 {
   assert!(!bools.value(i));
}
assert!(bools.value(9));

// Freeze into a new bools vector.
let bools = bools.freeze();

See also: BitBuffer.

Implementations

impl BitBufferMut

pub fn from_buffer(buffer: ByteBufferMut, offset: usize, len: usize) -> Self

Create new bit buffer from given byte buffer and logical bit length

pub fn with_capacity(capacity: usize) -> Self

Create a new empty mutable bit buffer with requested capacity (in bits).

pub fn new_set(len: usize) -> Self

Create a new mutable buffer with requested len and all bits set to true.

pub fn new_unset(len: usize) -> Self

Create a new mutable buffer with requested len and all bits set to false.

pub fn empty() -> Self

Create a new empty BitBufferMut.

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

Create a new mutable buffer with requested len and all bits set to value.

pub fn len(&self) -> usize

Get the current populated length of the buffer.

pub fn is_empty(&self) -> bool

True if the buffer has length 0.

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

Get the value at the requested index.

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

Get the value at the requested index without bounds checking.

Safety

The caller must ensure that index is less than the length of the buffer.

pub fn capacity(&self) -> usize

Get the bit capacity of the buffer.

pub fn reserve(&mut self, additional: usize)

Reserve additional bit capacity for the buffer.

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

Set the bit at index to the given boolean value.

This operation is checked so if index exceeds the buffer length, this will panic.

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

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

Safety

The caller must ensure that index does not exceed the largest bit index in the backing buffer.

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

Set a position to true.

This operation is checked so if index exceeds the buffer length, this will panic.

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

Set a position to false.

This operation is checked so if index exceeds the buffer length, this will panic.

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

Set the bit at index to true without checking bounds.

Safety

The caller must ensure that index does not exceed the largest bit index in the backing buffer.

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

Unset the bit at index without checking bounds.

Safety

The caller must ensure that index does not exceed the largest bit index in the backing buffer.

pub fn truncate(&mut self, len: usize)

Truncate the buffer to the given length.

pub fn append(&mut self, value: bool)

Append a new boolean into the bit buffer, incrementing the length.

pub fn append_true(&mut self)

Append a new true value to the buffer.

pub fn append_false(&mut self)

Append a new false value to the buffer.

pub fn append_n(&mut self, value: bool, n: usize)

Append several boolean values into the bit buffer. After this operation, the length will be incremented by n.

Panics if the buffer does not have n slots left.

pub fn append_buffer(&mut self, buffer: &BitBuffer)

Append a BitBuffer to this BitBufferMut

This efficiently copies all bits from the source buffer to the end of this buffer.

pub fn freeze(self) -> BitBuffer

Freeze the buffer in its current state into an immutable BoolBuffer.

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

Trait Implementations

impl Default for BitBufferMut

fn default() -> Self

Returns the “default value” for a type.

impl From<&[bool]> for BitBufferMut

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

Converts to this type from the input type.

impl From<Vec<bool>> for BitBufferMut

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

Converts to this type from the input type.

impl FromIterator<bool> for BitBufferMut

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

Creates a value from an iterator.