Struct BoolVec

pub struct BoolVec { /* private fields */ }

A vector of boolean values.

Implementations

impl BoolVec

pub const fn new() -> Self

Creates a new, empty BoolVec. The BoolVec will not allocate until elements are pushed onto it.

pub fn with_capacity(capacity: usize) -> Self

Constructs a new, empty BoolVec with the specified capacity. The BoolVec will be able to hold exactly capacity * 8 booleans without reallocating. If capacity is 0, the BoolVec will not allocate.

pub fn filled_with(count: usize, value: bool) -> Self

Creates a new BoolVec containing count booleans set to value.

pub fn from_vec(vec: Vec<u8>) -> Self

Creates a BitVec from a vector of bytes.

pub fn count(&self) -> usize

Returns the number of booleans that are stored inside of this BoolVec.

pub fn is_empty(&self) -> bool

Is this BoolVec empty ?

pub fn capacity(&self) -> usize

Returns the capacity of this BoolVec, in bytes.

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

Identical to Vec::reserve.

additional_capacity is in bytes.

pub fn reserve_exact(&mut self, additional_capacity: usize)

Identical to Vec::reserve_exact.

additional_capacity is in bytes.

pub fn shrink_to_fit(&mut self)

Identical to Vec::shrink_to_fit.

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

Shortens the BoolVec, keeping the first count boolean values and dropping the rest.

If count is greater or equal to self.count(), this will have no effect.

pub unsafe fn get_unchecked_ref(&self, nth: usize) -> RefBool<'_>

Gets a reference to the nth boolean stored inside of this BoolVec.

Safety

No bound checks are made.

pub unsafe fn get_unchecked(&self, nth: usize) -> bool

Gets the nth boolean stored inside of this BoolVec.

Safety

The value of nth must be less than self.count().

pub fn get_ref(&self, nth: usize) -> Option<RefBool<'_>>

Gets a reference to the nth boolean stored inside of this BoolVec or None if nth is out of bounds.

pub fn get(&self, nth: usize) -> Option<bool>

Gets the the nth boolean stored inside of this BoolVec or None if nth is out of bounds.

pub unsafe fn get_unchecked_mut(&mut self, nth: usize) -> RefBoolMut<'_>

Gets a mutable reference to the nth boolean stored inside of this BoolVec.

Safety

The value of nth must be less than self.count().

pub fn get_mut(&mut self, nth: usize) -> Option<RefBoolMut<'_>>

Gets a mutable reference to the nth boolean stored inside of this BoolVec or None if nth is out of bounds.

pub unsafe fn set_unchecked(&mut self, nth: usize, value: bool)

Sets the value of the nth boolean stored inside of this BoolVec.

Safety

The value of nth must be less than self.count()

pub fn set(&mut self, nth: usize, value: bool)

Sets the value of the nth boolean stored inside of this BoolVec.

Panics

This function panics if nth is greater or equal to self.count().

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

Pushes a new boolean value into this BoolVec.

Panics

The function panics if the number of bytes allocated overflows usize.

pub fn pop(&mut self) -> Option<bool>

Removes the last boolean value from this BoolVec and returns it.

pub fn last_ref(&self) -> Option<RefBool<'_>>

Gets a reference to the last boolean stored in this BoolVec or None if the BoolVec is empty.

pub fn last_mut(&mut self) -> Option<RefBoolMut<'_>>

Gets a mutable reference to the last boolean stored in this BoolVec or None if the BoolVec is empty.

pub fn last(&self) -> Option<bool>

Gets the last boolean stored in this BoolVec or None if the vetor is empty.

pub fn clear(&mut self)

Clears this BoolVec.1

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

Creates a new iterator that iterates over the values of this BoolVec.

pub fn iter_mut(&mut self) -> IterMut<'_>

Creates a new iterator that iterates over mutable references of the values of this BoolVec.

pub fn bytes(&self) -> impl Iterator<Item = &u8>

Returns an iterator over the bytes of this BoolVec.

pub fn bytes_mut(&mut self) -> impl Iterator<Item = &mut u8>

Returns an iterator over the bytes of this BoolVec.

pub fn count_ones(&self) -> usize

Returns the number of bits that are set to 1 within this vector.

Trait Implementations

impl<'s> BitAnd for &'s BoolVec

type Output = BoolVec

The resulting type after applying the & operator.

fn bitand(self: &'s BoolVec, other: &'s BoolVec) -> BoolVec

Performs the & operation.

impl<'s> BitAndAssign<&'s BoolVec> for BoolVec

fn bitand_assign(&mut self, other: &'s BoolVec)

Performs the &= operation.

impl<'s> BitOr for &'s BoolVec

type Output = BoolVec

The resulting type after applying the | operator.

fn bitor(self: &'s BoolVec, other: &'s BoolVec) -> BoolVec

Performs the | operation.

impl<'s> BitOrAssign<&'s BoolVec> for BoolVec

fn bitor_assign(&mut self, other: &'s BoolVec)

Performs the |= operation.

impl<'s> BitXor for &'s BoolVec

type Output = BoolVec

The resulting type after applying the ^ operator.

fn bitxor(self: &'s BoolVec, other: &'s BoolVec) -> BoolVec

Performs the ^ operation.

impl<'s> BitXorAssign<&'s BoolVec> for BoolVec

fn bitxor_assign(&mut self, other: &'s BoolVec)

Performs the ^= operation.

impl Clone for BoolVec

fn clone(&self) -> BoolVec

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl FromIterator<bool> for BoolVec

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

Creates a value from an iterator.

impl FromIterator<u8> for BoolVec

fn from_iter<S: IntoIterator<Item = u8>>(iter: S) -> Self

Creates a value from an iterator.