Struct AtomicBitSet 

pub struct AtomicBitSet<A, V>(/* private fields */);

Atomic bitset backed by a single atomic primitive or a fixed-size array of atomics.

Atomicity guarantees

For single-primitive stores (e.g. AtomicBitSet<AtomicU64, V>), each method operates on one atomic word — all operations are truly atomic with respect to the entire bitset.

For multi-word stores (e.g. AtomicBitSet<[AtomicU64; 4], V>), each individual operation (insert, remove, contains, …) is atomic per word, but the bitset as a whole is not a single atomic unit. Concurrent modifications to bits in the same word are correctly synchronized. Modifications to bits in different words are independent atomic operations with no cross-word transactional guarantee. Composite queries like len(), iter(), or is_subset() may observe a mix of old and new state across words under concurrent mutation.

Implementations

impl<A: AtomicPrimStore, V> AtomicBitSet<A, V>

pub const fn new() -> Self

pub const fn empty() -> Self

pub fn from_element(elem: V) -> Self

where V: AsPrimitive<usize>, A::Item: PrimInt + BitOps,

pub fn from_bits(bits: A) -> Self

pub fn into_bits(self) -> A

pub fn len(&self) -> usize

where A::Item: PrimInt,

pub fn is_empty(&self) -> bool

where A::Item: PrimInt,

pub fn first(&self) -> Option<V>

where V: TryFrom<u8>, A::Item: PrimInt,

pub fn last(&self) -> Option<V>

where V: TryFrom<u8>, A::Item: PrimInt,

pub fn pop_first(&self) -> Option<V>

where V: TryFrom<u8>, A::Item: PrimInt + BitOps,

pub fn pop_last(&self) -> Option<V>

where V: TryFrom<u8>, A::Item: PrimInt + BitOps,

pub fn contains(&self, id: &V) -> bool

where V: Copy + AsPrimitive<usize>, A::Item: PrimInt,

pub fn set(&self, id: V, value: bool)

where V: AsPrimitive<usize>, A::Item: PrimInt + BitOps,

pub fn insert(&self, id: V) -> bool

where V: AsPrimitive<usize>, A::Item: PrimInt + BitOps,

pub fn remove(&self, id: V) -> bool

where V: AsPrimitive<usize>, A::Item: PrimInt + BitOps,

pub fn toggle(&self, id: V)

where V: AsPrimitive<usize>, A::Item: PrimInt + BitOps,

pub fn clear(&self)

where A::Item: PrimInt,

pub fn retain(&self, f: impl FnMut(V) -> bool)

where V: TryFrom<u8>, A::Item: PrimInt + BitOps,

pub fn union(&self, other: A::Item) -> BitSet<A::Item, V>

where A::Item: PrimInt + PrimStore,

pub fn difference(&self, other: A::Item) -> BitSet<A::Item, V>

where A::Item: PrimInt + PrimStore,

pub fn includes(&self, other: A::Item) -> bool

where A::Item: PrimInt,

pub fn iter(&self) -> PrimBitSetIter<A::Item, V>

where A::Item: PrimInt,

pub fn load_store(&self) -> A::Item

where A::Item: Clone,

pub fn swap_store(&self, store: &mut A::Item)

where A::Item: Copy,

pub fn union_from(&self, other: A::Item)

where A::Item: Copy + BitOps,

pub fn drain(&self) -> PrimBitSetIter<A::Item, V>

where A::Item: Copy + PrimInt + Zero,

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

where A::Item: PrimInt,

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

where A::Item: PrimInt,

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

where A::Item: PrimInt,

impl<A: Radium, V, const N: usize> AtomicBitSet<[A; N], V>

pub const fn new() -> Self

pub const fn empty() -> Self

pub fn from_bits(raw: [A; N]) -> Self

pub fn from_element(id: V) -> Self

where V: AsPrimitive<usize>, A::Item: PrimInt + BitOps,

pub fn into_bits(self) -> [A; N]

pub fn union_from(&self, other: &BitSet<[<A as Radium>::Item; N], V>)

where <A as Radium>::Item: BitOps + Copy + PrimStore,

pub fn drain(&self) -> BitSet<[<A as Radium>::Item; N], V>

where <A as Radium>::Item: Copy + PrimInt + PrimStore,

Methods from Deref<Target = AtomicBitSlice<A, V>>

pub fn as_raw_slice(&self) -> &[A]

pub fn capacity(&self) -> usize

pub fn len(&self) -> usize

pub fn is_empty(&self) -> bool

pub fn first(&self) -> Option<V>

where V: TryFrom<usize>,

pub fn last(&self) -> Option<V>

where V: TryFrom<usize>,

pub fn pop_first(&self) -> Option<V>

where V: TryFrom<usize>, A::Item: BitOps,

pub fn pop_last(&self) -> Option<V>

where V: TryFrom<usize>, A::Item: BitOps,

pub fn contains(&self, id: &V) -> bool

where V: Copy + AsPrimitive<usize>,

pub fn insert(&self, id: V) -> bool

where V: AsPrimitive<usize>, A::Item: BitOps,

pub fn remove(&self, id: V) -> bool

where V: AsPrimitive<usize>, A::Item: BitOps,

pub fn set(&self, id: V, value: bool)

where V: AsPrimitive<usize>, A::Item: BitOps,

pub fn toggle(&self, id: V)

where V: AsPrimitive<usize>, A::Item: BitOps,

pub fn clear(&self)

pub fn retain(&self, f: impl FnMut(V) -> bool)

where V: TryFrom<usize>, A::Item: BitOps,

pub fn iter(&self) -> impl Iterator<Item = V> + '_

where A::Item: BitAndAssign, V: TryFrom<usize>,

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

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

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

pub fn union_from(&self, other: &[A::Item])

where A::Item: BitOps + Copy,

Trait Implementations

impl<A: AtomicPrimStore, V> Binary for AtomicBitSet<A, V>

where A::Item: PrimInt + Binary,

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

Formats the value using the given formatter.

impl<A: Radium, V, const N: usize> Debug for AtomicBitSet<[A; N], V>

where A::Item: PrimInt,

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

Formats the value using the given formatter.

impl<A: AtomicPrimStore, V> Debug for AtomicBitSet<A, V>

where A::Item: PrimInt,

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

Formats the value using the given formatter.

impl<A: Radium, V, const N: usize> Default for AtomicBitSet<[A; N], V>

fn default() -> Self

Returns the “default value” for a type.

impl<A: AtomicPrimStore, V> Default for AtomicBitSet<A, V>

fn default() -> Self

Returns the “default value” for a type.

impl<A: Radium, V, const N: usize> Deref for AtomicBitSet<[A; N], V>

where A::Item: PrimInt,

type Target = AtomicBitSlice<A, V>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<A: AtomicPrimStore, V> LowerHex for AtomicBitSet<A, V>

where A::Item: PrimInt + LowerHex,

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

Formats the value using the given formatter.

impl<A: AtomicPrimStore, V> Octal for AtomicBitSet<A, V>

where A::Item: PrimInt + Octal,

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

Formats the value using the given formatter.

impl<A: AtomicPrimStore, V> UpperHex for AtomicBitSet<A, V>

where A::Item: PrimInt + UpperHex,

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

Formats the value using the given formatter.