Struct MaskMut 

pub struct MaskMut(/* private fields */);

A mutable mask, used for lazily allocating the bit buffer as required.

Implementations

impl MaskMut

pub fn empty() -> MaskMut

Creates a new empty mask.

pub fn with_capacity(capacity: usize) -> MaskMut

Creates a new empty mask with the default capacity.

pub fn new(len: usize, value: bool) -> MaskMut

Creates a new mask with the specified capacity.

pub fn new_true(len: usize) -> MaskMut

Creates a new mask with all values set to true.

pub fn new_false(len: usize) -> MaskMut

Creates a new mask with all values set to false.

pub fn from_buffer(bit_buffer: BitBufferMut) -> MaskMut

Creates a new mask from an existing bit buffer.

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

Returns the boolean value at a given index.

Panics

Panics if the index is out of bounds.

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

Reserve capacity for at least additional more values to be appended.

pub unsafe fn set_len(&mut self, new_len: usize)

Set the length of the mask.

Safety

• new_len must be less than or equal to capacity().
• The elements at old_len..new_len must be initialized.

pub fn capacity(&self) -> usize

Returns the capacity of the mask.

pub fn clear(&mut self)

Clears the mask.

Note that this method has no effect on the allocated capacity of the mask.

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

Shortens the mask, keeping the first len bits.

If len is greater or equal to the vector’s current length, this has no effect.

Note that this method has no effect on the allocated capacity of the mask.

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

Append n values to the mask.

pub fn append_mask(&mut self, other: &Mask)

Append a Mask to this mutable mask.

pub fn split_off(&mut self, at: usize) -> MaskMut

Split-off the mask at the given index, returning a new mask with the values from at to the end, and leaving self with the values from the start to at.

pub fn unsplit(&mut self, other: MaskMut)

Absorb another mask into this one, appending its values.

pub fn freeze(self) -> Mask

Freezes the mutable mask into an immutable one.

pub fn len(&self) -> usize

Returns the logical length of the mask.

pub fn is_empty(&self) -> bool

Returns true if the mask is empty.

pub fn all_true(&self) -> bool

Returns true if all values in the mask are true.

pub fn all_false(&self) -> bool

Returns true if all values in the mask are false.

pub fn as_bit_buffer_mut(&mut self) -> Option<&mut BitBufferMut>

Returns the internal bit buffer if it exists.

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

Set the value at the given index to true.

Panics

Panics if the index is out of bounds.

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

Set the value at the given index to false.

Panics

Panics if the index is out of bounds.

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

Set the value at the given index to the specified boolean value.

Panics

Panics if the index is out of bounds.

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

Set the value at the given index to true without bounds checking.

Safety

The caller must ensure that index < self.len().

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

Set the value at the given index to false without bounds checking.

Safety

The caller must ensure that index < self.len().

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

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

Safety

The caller must ensure that index < self.len().

Trait Implementations

impl Clone for MaskMut

fn clone(&self) -> MaskMut

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MaskMut

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

Formats the value using the given formatter.

impl Default for MaskMut

fn default() -> MaskMut

Returns the “default value” for a type.

impl<const NB: usize> Filter<BitView<'_, NB>> for &mut MaskMut

type Output = ()

The result type after performing the operation.

fn filter( self, selection: &BitView<'_, NB>, ) -> <&mut MaskMut as Filter<BitView<'_, NB>>>::Output

Filters an object using the provided mask, returning a new value.

impl Filter<Mask> for &mut MaskMut

type Output = ()

The result type after performing the operation.

fn filter(self, selection_mask: &Mask)

Filters an object using the provided mask, returning a new value.