Struct unicycle::AtomicBitSet

#[repr(C)]
pub struct AtomicBitSet { /* fields omitted */ }

The same as BitSet, except it provides atomic methods.

BitSet and AtomicBitSet's are guaranteed to have an identical memory layout, so while it would require unsafe, transmuting or coercing between the two is sound assuming the proper synchronization is respected.

We provide the following methods to accomplish this from an atomic bitset, to a local (non atomic) one: as_local_mut for borrowing mutably and into_local.

Methods

impl AtomicBitSet

pub fn new() -> Self

Construct a new, empty atomic bit set.

Examples

use unicycle::AtomicBitSet;

let set = AtomicBitSet::new();
let set = set.into_local();
assert!(set.is_empty());

pub fn set(&self, position: usize)

Set the given bit atomically.

We can do this to an AtomicBitSet since the required modifications that needs to be performed against each layer are idempotent of the order in which they are applied.

Panics

Call will panic if the position is not within the capacity of the AtomicBitSet.

Examples

use unicycle::BitSet;

let set = BitSet::with_capacity(1024).into_atomic();
set.set(1000);
let set = set.into_local();
assert!(set.test(1000));

pub fn into_local(self) -> BitSet

Convert in-place into a a BitSet.

This is safe, since this function requires exclusive owned access to the AtomicBitSet, and we assert that their memory layouts are identical.

Examples

use unicycle::BitSet;

let mut set = BitSet::new();
set.reserve(1024);

let atomic = set.into_atomic();
atomic.set(42);

let set = atomic.into_local();
assert!(set.test(42));

pub fn as_local_mut(&mut self) -> &mut BitSet

Convert in-place into a mutable reference to a BitSet.

This is safe, since this function requires exclusive mutable access to the AtomicBitSet, and we assert that their memory layouts are identical.

Examples

use unicycle::BitSet;

let mut set = BitSet::with_capacity(1024).into_atomic();

set.set(21);
set.set(42);

{
    let set = set.as_local_mut();
    // Clearing is only safe with BitSet's since we require exclusive
    // mutable access to the collection being cleared.
    set.clear(21);
}

let set = set.into_local();
assert!(!set.test(21));
assert!(set.test(42));

Trait Implementations

impl Default for AtomicBitSet

fn default() -> Self

Returns the "default value" for a type.