Struct BitArray 

pub struct BitArray<T: BitStorage> { /* private fields */ }

Array of booleans as a large bit vector

Implementations

impl<T: BitStorage> BitArray<T>

pub fn new(size: usize) -> Self

Create a new bit array where the size is the expected number of bits.

pub fn with_capacity(capacity: usize) -> Self

Empty vector with some bytes allocated, where the size of the memory allocated depends on the underlying integer size used.

pub const fn len(&self) -> usize

Number of bits in use

pub const fn is_empty(&self) -> bool

Returns true if the array contains no elements.

pub fn all_zeroes(&self) -> bool

Indicates if none of the bits are set

pub const fn capacity(&self) -> usize

Number of bits available

pub fn iter(&self) -> BitArrayIterator<'_, T>

Iterate over the bits in the array

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

where <T as BitAnd>::Output: PartialEq<T>,

Get the bit value from a given index

Panic

This will panic if index points to a value beyond the number of bits stored in this array.

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

Set the bit value at a given index

Panic

This will panic if index points to a value beyond the number of bits stored in this array.

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

Unset the bit at a given index

Panic

This will panic if index points to a value beyond the number of bits stored in this array.

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

Push a new bit onto the end of the array.

pub fn clear(&mut self)

Clear all bits

pub fn reset(&mut self)

Remove all data and set the size to zero

Trait Implementations

impl<T: Clone + BitStorage> Clone for BitArray<T>

fn clone(&self) -> BitArray<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug + BitStorage> Debug for BitArray<T>

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

Formats the value using the given formatter.

impl<T: Default + BitStorage> Default for BitArray<T>

fn default() -> BitArray<T>

Returns the “default value” for a type.

impl<'de, T: BitStorage> Deserialize<'de> for BitArray<T>

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T: BitStorage> Display for BitArray<T>

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

Formats the value using the given formatter.

impl<T: BitStorage> FromStr for BitArray<T>

type Err = String

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl<T: Hash + BitStorage> Hash for BitArray<T>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<'a, T: BitStorage + 'a> IntoIterator for &'a BitArray<T>

type Item = bool

The type of the elements being iterated over.

type IntoIter = BitArrayIterator<'a, T>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<T: BitStorage> IntoIterator for BitArray<T>

type Item = bool

The type of the elements being iterated over.

type IntoIter = BitArrayOwnedIterator<T>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<T: PartialEq + BitStorage> PartialEq for BitArray<T>

fn eq(&self, other: &BitArray<T>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T: BitStorage> Serialize for BitArray<T>

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl<T: Eq + BitStorage> Eq for BitArray<T>

impl<T: BitStorage> StructuralPartialEq for BitArray<T>