Struct BitVec 

pub struct BitVec { /* private fields */ }

A compact set of bits.

Iteration yields set positions rather than every position, so walking a sparse mask costs one step per member instead of one per candidate.

Implementations

impl BitVec

pub fn new() -> Self

Creates an empty set.

pub fn repeat(value: bool, len: u32) -> Self

Creates a set of len bits, all equal to value.

pub fn with_capacity(len: u32) -> Self

Creates a set with room for len bits without reallocating.

pub const fn len(&self) -> u32

The number of bits held.

pub const fn is_empty(&self) -> bool

Returns true when no bit is held.

pub fn try_push(&mut self, value: bool) -> Result<(), CapacityError>

Appends a bit.

Errors

Returns CapacityError without mutation when the u32 position space is full.

pub fn get(&self, position: u32) -> Option<bool>

Returns the bit at position, or None if it is past the end.

pub fn test(&self, position: u32) -> bool

Returns the bit at position, treating a position past the end as unset.

pub fn set(&mut self, position: u32, value: bool)

Sets the bit at position, ignoring a position past the end.

pub fn count_ones(&self) -> u32

The number of set bits.

pub fn all(&self) -> bool

Returns true when every bit is set.

pub fn none(&self) -> bool

Returns true when no bit is set.

pub fn ones(&self) -> Ones<'_>

The set positions, ascending.

Skips whole words that hold nothing, so a mask with one member in a million bits costs a scan of sixteen thousand words rather than a million tests.

A position space beyond u32 ends the walk rather than panicking.

pub fn intersect_with(&mut self, other: &Self)

Keeps only the bits also set in other.

pub fn union_with(&mut self, other: &Self)

Adds every bit set in other.

Bits of other beyond this set’s length are ignored; the length is a property of the structure, not of the operation.

pub fn invert(&mut self)

Inverts every bit.

impl BitVec

pub fn try_from_iter<T: IntoIterator<Item = bool>>(iter: T) -> Option<Self>

Builds a bit vector, returning None if its position space is exhausted.

Trait Implementations

impl Clone for BitVec

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BitVec

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

Formats the value using the given formatter.

impl Default for BitVec

fn default() -> Self

Returns the “default value” for a type.

impl Eq for BitVec

impl PartialEq for BitVec

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for BitVec