Struct shuttle::sync::atomic::AtomicI32

pub struct AtomicI32 { /* private fields */ }

An integer type which can be safely shared between threads.

Implementations

impl AtomicI32

pub const fn new(v: i32) -> Self

Creates a new atomic integer.

pub fn get_mut(&mut self) -> &mut i32

Returns a mutable reference to the underlying integer.

pub fn into_inner(self) -> i32

Consumes the atomic and returns the contained value.

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

Loads a value from the atomic integer.

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

Stores a value into the atomic integer.

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

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

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

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

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).

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

👎Deprecated since 0.0.6: Use compare_exchange or compare_exchange_weak instead

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

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

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

The return value is a result indicating whether the new value was written and containing the previous value. On success this value is guaranteed to be equal to current.

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

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

Unlike compare_exchange, this function is allowed to spuriously fail even when the comparison succeeds, which can result in more efficient code on some platforms. The return value is a result indicating whether the new value was written and containing the previous value.

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

Adds to the current value, returning the previous value.

This operation wraps around on overflow.

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

Subtracts from the current value, returning the previous value.

This operation wraps around on overflow.

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

Bitwise “and” with the current value. Returns the previous value.

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

Bitwise “nand” with the current value. Returns the previous value.

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

Bitwise “or” with the current value. Returns the previous value.

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

Bitwise “xor” with the current value. Returns the previous value.

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

Maximum with the current value. Returns the previous value.

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

Minimum with the current value. Returns the previous value.

pub unsafe fn raw_load(&self) -> i32

Load the atomic value directly without triggering any Shuttle context switches.

Safety

Shuttle does not consider potential concurrent interleavings of this function call, and so it should be used when those interleavings aren’t important (primarily in debugging scenarios where we might want to just print this atomic’s value).

Trait Implementations

impl Debug for AtomicI32

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

Formats the value using the given formatter.

impl Default for AtomicI32

fn default() -> Self

Returns the “default value” for a type.

impl From<i32> for AtomicI32

fn from(v: i32) -> Self

Converts to this type from the input type.