[][src]Struct fixedbitset::FixedBitSet

pub struct FixedBitSet { /* fields omitted */ }

FixedBitSet is a simple fixed size set of bits that each can be enabled (1 / true) or disabled (0 / false).

The bit set has a fixed capacity in terms of enabling bits (and the capacity can grow using the grow method).

Methods

impl FixedBitSet[src]

pub fn with_capacity(bits: usize) -> Self[src]

Create a new FixedBitSet with a specific number of bits, all initially clear.

pub fn grow(&mut self, bits: usize)[src]

Grow capacity to bits, all new bits initialized to zero

pub fn len(&self) -> usize[src]

Return the length of the FixedBitSet in bits.

pub fn contains(&self, bit: usize) -> bool[src]

Return true if the bit is enabled in the FixedBitSet, false otherwise.

Note: bits outside the capacity are always disabled.

Note: Also available with index syntax: bitset[bit].

pub fn clear(&mut self)[src]

Clear all bits.

pub fn insert(&mut self, bit: usize)[src]

Enable bit.

Panics if bit is out of bounds.

pub fn put(&mut self, bit: usize) -> bool[src]

Enable bit, and return its previous value.

Panics if bit is out of bounds.

pub fn toggle(&mut self, bit: usize)[src]

Toggle bit (inverting its state).

Panics if bit is out of bounds

pub fn set(&mut self, bit: usize, enabled: bool)[src]

Panics if bit is out of bounds.

pub fn copy_bit(&mut self, from: usize, to: usize)[src]

Copies boolean value from specified bit to the specified bit.

Panics if to is out of bounds.

pub fn count_ones<T: IndexRange>(&self, range: T) -> usize[src]

Count the number of set bits in the given bit range.

Use .. to count the whole content of the bitset.

Panics if the range extends past the end of the bitset.

pub fn set_range<T: IndexRange>(&mut self, range: T, enabled: bool)[src]

Sets every bit in the given range to the given state (enabled)

Use .. to toggle the whole bitset.

Panics if the range extends past the end of the bitset.

pub fn insert_range<T: IndexRange>(&mut self, range: T)[src]

Enables every bit in the given range.

Use .. to make the whole bitset ones.

Panics if the range extends past the end of the bitset.

pub fn as_slice(&self) -> &[u32][src]

View the bitset as a slice of u32 blocks

pub fn as_mut_slice(&mut self) -> &mut [u32][src]

View the bitset as a mutable slice of u32 blocks. Writing past the bitlength in the last will cause contains to return potentially incorrect results for bits past the bitlength.

Important traits for Ones<'a>
pub fn ones(&self) -> Ones[src]

Iterates over all enabled bits.

Iterator element is the index of the 1 bit, type usize.

Important traits for Intersection<'a>
pub fn intersection<'a>(&'a self, other: &'a FixedBitSet) -> Intersection<'a>[src]

Returns a lazy iterator over the intersection of two FixedBitSets

Important traits for Union<'a>
pub fn union<'a>(&'a self, other: &'a FixedBitSet) -> Union<'a>[src]

Returns a lazy iterator over the union of two FixedBitSets.

Important traits for Difference<'a>
pub fn difference<'a>(&'a self, other: &'a FixedBitSet) -> Difference<'a>[src]

Returns a lazy iterator over the difference of two FixedBitSets. The difference of a and b is the elements of a which are not in b.

Important traits for SymmetricDifference<'a>
pub fn symmetric_difference<'a>(
    &'a self,
    other: &'a FixedBitSet
) -> SymmetricDifference<'a>
[src]

Returns a lazy iterator over the symmetric difference of two FixedBitSets. The symmetric difference of a and b is the elements of one, but not both, sets.

pub fn union_with(&mut self, other: &FixedBitSet)[src]

In-place union of two FixedBitSets.

pub fn intersect_with(&mut self, other: &FixedBitSet)[src]

In-place intersection of two FixedBitSets.

pub fn symmetric_difference_with(&mut self, other: &FixedBitSet)[src]

In-place symmetric difference of two FixedBitSets.

pub fn is_disjoint(&self, other: &FixedBitSet) -> bool[src]

Returns true if self has no elements in common with other. This is equivalent to checking for an empty intersection.

pub fn is_subset(&self, other: &FixedBitSet) -> bool[src]

Returns true if the set is a subset of another, i.e. other contains at least all the values in self.

pub fn is_superset(&self, other: &FixedBitSet) -> bool[src]

Returns true if the set is a superset of another, i.e. self contains at least all the values in other.

Trait Implementations

impl Eq for FixedBitSet[src]

impl Default for FixedBitSet[src]

impl Clone for FixedBitSet[src]

impl PartialOrd<FixedBitSet> for FixedBitSet[src]

impl Extend<usize> for FixedBitSet[src]

Sets the bit at index i to true for each item i in the input src.

impl PartialEq<FixedBitSet> for FixedBitSet[src]

impl Ord for FixedBitSet[src]

impl Hash for FixedBitSet[src]

impl<'a> BitAnd<&'a FixedBitSet> for &'a FixedBitSet[src]

type Output = FixedBitSet

The resulting type after applying the & operator.

impl<'a> BitOr<&'a FixedBitSet> for &'a FixedBitSet[src]

type Output = FixedBitSet

The resulting type after applying the | operator.

impl<'a> BitXor<&'a FixedBitSet> for &'a FixedBitSet[src]

type Output = FixedBitSet

The resulting type after applying the ^ operator.

impl<'a> BitAndAssign<FixedBitSet> for FixedBitSet[src]

impl<'a> BitOrAssign<FixedBitSet> for FixedBitSet[src]

impl<'a> BitXorAssign<FixedBitSet> for FixedBitSet[src]

impl Index<usize> for FixedBitSet[src]

Return true if the bit is enabled in the bitset, or false otherwise.

Note: bits outside the capacity are always disabled, and thus indexing a FixedBitSet will not panic.

type Output = bool

The returned type after indexing.

impl Debug for FixedBitSet[src]

impl FromIterator<usize> for FixedBitSet[src]

Return a FixedBitSet containing bits set to true for every bit index in the iterator, other bits are set to false.

Auto Trait Implementations

Blanket Implementations

impl<T> ToOwned for T where
    T: Clone
[src]

type Owned = T

The resulting type after obtaining ownership.

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<T> From<T> for T[src]

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> Any for T where
    T: 'static + ?Sized
[src]