Struct AtomicFlags 

pub struct AtomicFlags<F>
where
    F: Flags + Copy,
    F::Bits: AtomicBits,
{ /* private fields */ }

A flag set stored in an atomic integer.

Implementations

impl<F> AtomicFlags<F>

where F: Flags + Copy, F::Bits: AtomicBits,

pub fn new(flags: F) -> Self

pub fn store(&self, flags: F, ordering: Ordering)

pub fn load(&self, ordering: Ordering) -> F

pub fn fetch_and(&self, flags: F, ordering: Ordering) -> F

Atomically clears flags, returning the previous value.

pub fn fetch_or(&self, flags: F, ordering: Ordering) -> F

Atomically sets flags, returning the previous value.

pub fn fetch_xor(&self, flags: F, ordering: Ordering) -> F

Atomically toggles flags, returning the previous value.

pub fn fetch_nand(&self, flags: F, ordering: Ordering) -> F

Atomically replaces the value with !(current & flags), returning the previous value.

This follows the standard atomic fetch_nand: the result is not restricted to flags, so bits outside the mask are set.

pub fn swap(&self, flags: F, ordering: Ordering) -> F

Atomically replaces the value with flags, returning the previous value.

pub fn take(&self, flags: F, ordering: Ordering) -> F

Atomically clears flags and returns the subset that was set.

Returns an empty set if none of flags were set. Other bits are left untouched.

pub fn peek(&self, flags: F, ordering: Ordering) -> F

Returns the subset of flags that is currently set.

Does not modify the stored value. The result is a snapshot from a single load; use take to claim flags atomically.

pub fn clear(&self, ordering: Ordering)

Clears all flags.

pub fn into_inner(self) -> F

Consumes the atomic and returns the flags.

pub fn set(&self, flags: F, ordering: Ordering) -> F

Atomically sets the bits in flags, returning the previous value.

pub fn unset(&self, flags: F, ordering: Ordering) -> F

Atomically clears the bits in flags, returning the previous value.

Trait Implementations

impl<F> Debug for AtomicFlags<F>

where F: Flags + Copy + Debug, F::Bits: AtomicBits,

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

Formats the value using the given formatter.

impl<F> Default for AtomicFlags<F>

where F: Flags + Copy + Default, F::Bits: AtomicBits,

fn default() -> Self

Returns the “default value” for a type.