Struct loom::sync::atomic::AtomicBool

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

Mock implementation of std::sync::atomic::AtomicBool.

NOTE: Unlike std::sync::atomic::AtomicBool, this type has a different in-memory representation than bool.

Implementations

impl AtomicBool

pub fn new(v: bool) -> AtomicBool

Creates a new instance of AtomicBool.

pub unsafe fn unsync_load(&self) -> bool

Load the value without any synchronization.

Safety

An unsynchronized atomic load technically always has undefined behavior. However, if the atomic value is not currently visible by other threads, this should always be equivalent to a non-atomic load of an un-shared bool value.

pub fn into_inner(self) -> bool

Consumes the atomic and returns the contained value.

pub fn load(&self, order: Ordering) -> bool

Loads a value from the atomic bool.

pub fn store(&self, val: bool, order: Ordering)

Stores a value into the atomic bool.

pub fn swap(&self, val: bool, order: Ordering) -> bool

Stores a value into the atomic bool, returning the previous value.

pub fn compare_and_swap( &self, current: bool, new: bool, order: Ordering ) -> bool

Stores a value into the atomic bool if the current value is the same as the current value.

pub fn compare_exchange( &self, current: bool, new: bool, success: Ordering, failure: Ordering ) -> Result<bool, bool>

Stores a value into the atomic if the current value is the same as the current value.

pub fn compare_exchange_weak( &self, current: bool, new: bool, success: Ordering, failure: Ordering ) -> Result<bool, bool>

Stores a value into the atomic if the current value is the same as the current value.

pub fn fetch_and(&self, val: bool, order: Ordering) -> bool

Logical “and” with the current value.

pub fn fetch_nand(&self, val: bool, order: Ordering) -> bool

Logical “nand” with the current value.

pub fn fetch_or(&self, val: bool, order: Ordering) -> bool

Logical “or” with the current value.

pub fn fetch_xor(&self, val: bool, order: Ordering) -> bool

Logical “xor” with the current value.

pub fn fetch_update<F>( &self, set_order: Ordering, fetch_order: Ordering, f: F ) -> Result<bool, bool>

where F: FnMut(bool) -> Option<bool>,

Fetches the value, and applies a function to it that returns an optional new value. Returns a Result of Ok(previous_value) if the function returned Some(_), else Err(previous_value).

Trait Implementations

impl Debug for AtomicBool

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

Formats the value using the given formatter.

impl Default for AtomicBool

fn default() -> AtomicBool

Returns the “default value” for a type.

impl From<bool> for AtomicBool

fn from(b: bool) -> Self

Converts to this type from the input type.