Struct shuttle::sync::atomic::AtomicU8

pub struct AtomicU8 { /* private fields */ }

An integer type which can be safely shared between threads.

Implementations

impl AtomicU8

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

Creates a new atomic integer.

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

Returns a mutable reference to the underlying integer.

pub fn into_inner(self) -> u8

Consumes the atomic and returns the contained value.

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

Loads a value from the atomic integer.

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

Stores a value into the atomic integer.

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

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<u8, u8>

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

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: u8, new: u8, order: Ordering) -> u8

👎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: u8, new: u8, success: Ordering, failure: Ordering ) -> Result<u8, u8>

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: u8, new: u8, success: Ordering, failure: Ordering ) -> Result<u8, u8>

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: u8, order: Ordering) -> u8

Adds to the current value, returning the previous value.

This operation wraps around on overflow.

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

Subtracts from the current value, returning the previous value.

This operation wraps around on overflow.

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

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

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

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

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

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

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

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

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

Maximum with the current value. Returns the previous value.

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

Minimum with the current value. Returns the previous value.

pub unsafe fn raw_load(&self) -> u8

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 AtomicU8

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

Formats the value using the given formatter.

impl Default for AtomicU8

fn default() -> Self

Returns the “default value” for a type.

impl From<u8> for AtomicU8

fn from(v: u8) -> Self

Converts to this type from the input type.