Struct bitvec_rs::BitVec

pub struct BitVec { /* fields omitted */ }

Bit vector with guaranteed [u8] representation and safe mutable access to this slice. Slices into the bit vector are guaranteed to have the unused bits on the last set to 0.

Methods

impl BitVec

pub fn new() -> BitVec

Constructs an empty BitVec.

pub fn with_capacity(capacity: usize) -> BitVec

Constructs an empty BitVec with the given capacity.

The bit vector will be able to hold at least capacity bits without reallocating. If capacity is 0, the bit vector will not allocate.

pub fn from_bytes(bytes: &[u8]) -> BitVec

Constructs a BitVec from bytes.

pub fn from_bools(bools: &[bool]) -> BitVec

Constructs a BitVec from bools.

pub fn from_elem(len: usize, value: bool) -> BitVec

Constructs a BitVec from a repeating bit value.

pub fn as_bytes(&self) -> &[u8]

Returns a byte slice view of the data.

pub fn with_bytes_mut<U, F: FnOnce(&mut [u8]) -> U>(&mut self, f: F) -> U

Invokes the given function on a mut byte slice view of the data. After f completes, the trailing unused bits of the last byte are automatically set to 0.

pub fn into_vec(self) -> Vec<u8>

Consumes the self and returns the underlying Vec<u8> of length ceil(self.len()/8). The values of the bits in the last byte of Vec<u8> beyond the length of the BitVec are unspecified.

pub fn len(&self) -> usize

Returns the length of the bit vector.

pub fn is_empty(&self) -> bool

Returns whether the vector is empty.

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

Gets the bit at the given index.

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

Sets the bit at the given index. Panics if index exceeds length.

pub fn swap(&mut self, i: usize, j: usize)

Swaps two elements in the BitVec.

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

Gets the bit at the given index without bounds checking.

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

Sets the bit at the given index without bounds checking.

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

Pushes a boolean to the end of the BitVec.

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

Pops a boolean from the end of the BitVec.

pub fn clear(&mut self)

Clears the BitVec, removing all values.

pub fn capacity(&self) -> usize

Returns the number of booleans that the bitvec can hold without reallocating.

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

Reserves capacity for at least additional more booleans to be inserted in the given BitVec. The collection may reserve more space to avoid frequent reallocations.

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

Shorten a vector, dropping excess elements.

If len is greater than the vector's current length, this has no effect.

pub fn resize(&mut self, new_len: usize, value: bool)

Reserves capacity for at least additional more booleans to be inserted in the given BitVec. The collection may reserve more space to avoid frequent reallocations.

Important traits for Iter<'a>

impl<'a> Iterator for Iter<'a> type Item = bool;

pub fn iter(&self) -> Iter

Returns an iterator for the booleans in the array.

Trait Implementations

impl Eq for BitVec

impl Default for BitVec

fn default() -> BitVec

Returns the "default value" for a type.

impl PartialEq<BitVec> for BitVec

fn eq(&self, other: &BitVec) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &BitVec) -> bool

This method tests for !=.

impl<'_> From<&'_ [bool]> for BitVec

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

Performs the conversion.

impl<'_> From<&'_ Vec<bool>> for BitVec

fn from(bools: &Vec<bool>) -> Self

Performs the conversion.

impl From<Vec<bool>> for BitVec

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

Performs the conversion.

impl<'a> From<&'a BitVec> for Vec<bool>

fn from(vec: &'a BitVec) -> Self

Performs the conversion.

impl<'a> From<BitVec> for Vec<bool>

fn from(vec: BitVec) -> Self

Performs the conversion.

impl Clone for BitVec

fn clone(&self) -> BitVec

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Extend<bool> for BitVec

fn extend<T>(&mut self, iterable: T) where
    T: IntoIterator<Item = bool>, 

Extends a collection with the contents of an iterator.

impl<'a> Extend<&'a bool> for BitVec

fn extend<T>(&mut self, iterable: T) where
    T: IntoIterator<Item = &'a bool>, 

Extends a collection with the contents of an iterator.

impl Display for BitVec

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

Formats the value using the given formatter.

impl Debug for BitVec

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

Formats the value using the given formatter.

impl Index<usize> for BitVec

type Output = bool

The returned type after indexing.

fn index(&self, index: usize) -> &Self::Output

Performs the indexing (container[index]) operation.