Struct BitSet64 

pub struct BitSet64(/* private fields */);

A memory-efficient 64-bit set for embedded environments. Note that it data is a singlet: this makes comparison with BitSet128 duplet clearer.

Implementations

impl BitSet64

pub const fn new() -> Self

Create a new empty bitset.

impl BitSet64

pub fn reset_all(&mut self)

Resets all bits to 0.

pub fn reset(&mut self, index: u8)

Resets the bit at index to 0. Does nothing if the index is out of bounds.

pub fn set_all(&mut self)

Sets all bits to 1.

pub fn set(&mut self, index: u8)

Sets the bit at index to 1. Does nothing if the index is out of bounds.

pub fn flip(&mut self, index: u8)

Flips the bit at index. Does nothing if the index is out of bounds.

pub fn flip_all(&mut self)

Flips all bits in the bitset (0s become 1s, and 1s become 0s).

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

In-place Difference / Mask-Clear. Clears any bits that are set in other. This represents the mathematical operation: self = self AND NOT other.

pub fn test(&self, index: u8) -> bool

Tests if the bit at index is 1. Returns false if the bit is 0 or index is out of bounds.

pub const fn count_ones(&self) -> u32

Returns the number of set bits (population count).

pub const fn leading_zeros(&self) -> u32

Returns the number of leading zeros in the bitset, counting from the most significant bit (index 63).

pub const fn is_empty(&self) -> bool

Returns true if no bits are set.

pub const fn last_set(&self) -> Option<u8>

Returns the highest index set, or None if the bitset is empty. Useful for finding the “top” of a priority queue or resource map.

pub const fn is_superset(&self, other: &BitSet64) -> bool

Returns true if this bitset contains all the bits set in other.

pub const fn is_subset(&self, other: &BitSet64) -> bool

Returns true if this bitset is a subset of other.

pub const fn intersects(&self, other: &Self) -> bool

Returns true if this bitset shares at least one common set bit with other. Returns false if there is no overlap or if either bitset is empty.

pub fn iter(&self) -> BitSet64Iter

Returns an iterator over the indices of the set bits.

Trait Implementations

impl Binary for BitSet64

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

Formats the value using the given formatter.

impl BitAnd for BitSet64

type Output = BitSet64

The resulting type after applying the & operator.

fn bitand(self, rhs: Self) -> Self::Output

Performs the & operation.

impl BitAndAssign for BitSet64

fn bitand_assign(&mut self, rhs: Self)

Performs the &= operation.

impl BitOr for BitSet64

type Output = BitSet64

The resulting type after applying the | operator.

fn bitor(self, rhs: Self) -> Self::Output

Performs the | operation.

impl BitOrAssign for BitSet64

fn bitor_assign(&mut self, rhs: Self)

Performs the |= operation.

impl BitXor for BitSet64

type Output = BitSet64

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: Self) -> Self::Output

Performs the ^ operation.

impl BitXorAssign for BitSet64

fn bitxor_assign(&mut self, rhs: Self)

Performs the ^= operation.

impl Clone for BitSet64

fn clone(&self) -> BitSet64

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BitSet64

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

Formats the value using the given formatter.

impl Default for BitSet64

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for BitSet64

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Extend<u8> for BitSet64

fn extend<I: IntoIterator<Item = u8>>(&mut self, iter: I)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl From<(u32, u32)> for BitSet64

BitSet64 from (u32,u32).

fn from((a, b): (u32, u32)) -> Self

Converts to this type from the input type.

impl From<u32> for BitSet64

BitSet64 from u32.

fn from(a: u32) -> Self

Converts to this type from the input type.

impl FromIterator<u8> for BitSet64

From iterator for bitset.

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

Creates a value from an iterator.

impl Index<u8> for BitSet64

type Output = bool

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl Index<usize> for BitSet64

type Output = bool

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl IntoIterator for &BitSet64

Non-consuming iterator for bitset reference.

type Item = u8

The type of the elements being iterated over.

type IntoIter = BitSet64Iter

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl IntoIterator for BitSet64

Non-consuming iterator for bitset.

type Item = u8

The type of the elements being iterated over.

type IntoIter = BitSet64Iter

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl Ord for BitSet64

fn cmp(&self, other: &BitSet64) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for BitSet64

fn eq(&self, other: &BitSet64) -> 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 PartialOrd for BitSet64

fn partial_cmp(&self, other: &BitSet64) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for BitSet64

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl UpperHex for BitSet64

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

Formats the value using the given formatter.

impl Copy for BitSet64

impl Eq for BitSet64

impl StructuralPartialEq for BitSet64