Struct loom::sync::atomic::AtomicU16

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

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

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

Implementations

impl AtomicU16

pub fn new(v: u16) -> Self

Creates a new instance of AtomicU16.

pub fn with_mut<R>(&mut self, f: impl FnOnce(&mut u16) -> R) -> R

Get access to a mutable reference to the inner value.

pub unsafe fn unsync_load(&self) -> u16

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 integer value.

pub fn into_inner(self) -> u16

Consumes the atomic and returns the contained value.

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

Loads a value from the atomic integer.

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

Stores a value into the atomic integer.

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

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

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

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

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

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

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

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

pub fn fetch_add(&self, val: u16, order: Ordering) -> u16

Adds to the current value, returning the previous value.

pub fn fetch_sub(&self, val: u16, order: Ordering) -> u16

Subtracts from the current value, returning the previous value.

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

Bitwise “and” with the current value.

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

Bitwise “nand” with the current value.

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

Bitwise “or” with the current value.

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

Bitwise “xor” with the current value.

pub fn fetch_max(&self, val: u16, order: Ordering) -> u16

Stores the maximum of the current and provided value, returning the previous value

pub fn fetch_min(&self, val: u16, order: Ordering) -> u16

Stores the minimum of the current and provided value, returning the previous value

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

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

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 AtomicU16

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

Formats the value using the given formatter.

impl Default for AtomicU16

fn default() -> Self

Returns the “default value” for a type.

impl From<u16> for AtomicU16

fn from(v: u16) -> Self

Converts to this type from the input type.