Struct Atomic 

pub struct Atomic<T> { /* private fields */ }

Generic atomic which allows any T to be used as lock-free atomic integer.

This atomic allows only types whose size and alignment is compatible with u8, u16, u32, u64.

With exception of fetch_* methods, all atomic methods are implemented for generic T

fetch_* makes sense only to integers, hence they are implemented as specialized methods.

All methods require atomic support, if target has no atomics of required size, then it will fail to compile using particular methods.

Implementations

impl<T> Atomic<T>

pub const fn new(value: T) -> Atomic<T>

Creates a new instance

impl<T: Copy> Atomic<T>

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

Returns a mutable reference to the underlying type.

This is safe because the mutable reference guarantees that no other threads are concurrently accessing the atomic data.

pub fn into_inner(self) -> T

Consumes the atomic and returns the contained value.

This is safe because passing self by value guarantees that no other threads are concurrently accessing the atomic data.

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

Loads a value from the atomic integer.

load takes an Ordering argument which describes the memory ordering of this operation. Possible values are SeqCst, Acquire and Relaxed.

Panics

Panics if order is Release or AcqRel.

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

Stores a value into the atomic integer.

store takes an Ordering argument which describes the memory ordering of this operation. Possible values are SeqCst, Release and Relaxed.

Panics

Panics if order is Acquire or AcqRel.

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

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

swap takes an Ordering argument which describes the memory ordering of this operation. All ordering modes are possible. Note that using Acquire makes the store part of this operation Relaxed, and using Release makes the load part Relaxed.

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

Stores a value into the atomic 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.

compare_exchange takes two Ordering arguments to describe the memory ordering of this operation. success describes the required ordering for the read-modify-write operation that takes place if the comparison with current succeeds. failure describes the required ordering for the load operation that takes place when the comparison fails. Using Acquire as success ordering makes the store part of this operation Relaxed, and using Release makes the successful load Relaxed. The failure ordering can only be SeqCst, Acquire or Relaxed.

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

Stores a value into the atomic 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.

compare_exchange_weak takes two Ordering arguments to describe the memory ordering of this operation. success describes the required ordering for the read-modify-write operation that takes place if the comparison with current succeeds. failure describes the required ordering for the load operation that takes place when the comparison fails. Using Acquire as success ordering makes the store part of this operation Relaxed, and using Release makes the successful load Relaxed. The failure ordering can only be SeqCst, Acquire or Relaxed.

pub fn fetch_update<F: FnMut(T) -> Option<T>>( &self, set_order: Ordering, fetch_order: Ordering, cb: F, ) -> Result<T, T>

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

Note: This may call the function multiple times if the value has been changed from other threads in the meantime, as long as the function returns Some(_), but the function will have been applied only once to the stored value.

fetch_update takes two Ordering arguments to describe the memory ordering of this operation. The first describes the required ordering for when the operation finally succeeds while the second describes the required ordering for loads. These correspond to the success and failure orderings of compare_exchange respectively.

Using Acquire as success ordering makes the store part of this operation Relaxed, and using Release makes the final successful load Relaxed. The (failed) load ordering can only be SeqCst, Acquire or Relaxed.

impl Atomic<i8>

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

Bitwise and with the current value, returning the previous value.

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

Bitwise nand with the current value.

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

Bitwise or with the current value, returning the previous value.

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

Bitwise xor with the current value, returning the previous value.

impl Atomic<u8>

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

Bitwise and with the current value, returning the previous value.

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

Bitwise nand with the current value.

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

Bitwise or with the current value, returning the previous value.

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

Bitwise xor with the current value, returning the previous value.

impl Atomic<bool>

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

Bitwise and with the current value, returning the previous value.

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

Bitwise nand with the current value.

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

Bitwise or with the current value, returning the previous value.

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

Bitwise xor with the current value, returning the previous value.

impl Atomic<i16>

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

Bitwise and with the current value, returning the previous value.

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

Bitwise nand with the current value.

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

Bitwise or with the current value, returning the previous value.

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

Bitwise xor with the current value, returning the previous value.

impl Atomic<u16>

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

Bitwise and with the current value, returning the previous 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, returning the previous value.

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

Bitwise xor with the current value, returning the previous value.

impl Atomic<i32>

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

Bitwise and with the current value, returning the previous value.

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

Bitwise nand with the current value.

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

Bitwise or with the current value, returning the previous value.

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

Bitwise xor with the current value, returning the previous value.

impl Atomic<u32>

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

Bitwise and with the current value, returning the previous value.

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

Bitwise nand with the current value.

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

Bitwise or with the current value, returning the previous value.

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

Bitwise xor with the current value, returning the previous value.

impl Atomic<i64>

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

Bitwise and with the current value, returning the previous value.

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

Bitwise nand with the current value.

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

Bitwise or with the current value, returning the previous value.

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

Bitwise xor with the current value, returning the previous value.

impl Atomic<u64>

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

Bitwise and with the current value, returning the previous value.

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

Bitwise nand with the current value.

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

Bitwise or with the current value, returning the previous value.

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

Bitwise xor with the current value, returning the previous value.

impl Atomic<isize>

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

Bitwise and with the current value, returning the previous value.

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

Bitwise nand with the current value.

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

Bitwise or with the current value, returning the previous value.

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

Bitwise xor with the current value, returning the previous value.

impl Atomic<usize>

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

Bitwise and with the current value, returning the previous value.

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

Bitwise nand with the current value.

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

Bitwise or with the current value, returning the previous value.

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

Bitwise xor with the current value, returning the previous value.

impl Atomic<i8>

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

Minimum with the current value.

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

Maximum with the current value.

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

Adds to the current value, returning the previous value.

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

Subtract from the current value, returning the previous value.

impl Atomic<u8>

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

Minimum with the current value.

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

Maximum with the current value.

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

Adds to the current value, returning the previous value.

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

Subtract from the current value, returning the previous value.

impl Atomic<i16>

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

Minimum with the current value.

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

Maximum with the current value.

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

Adds to the current value, returning the previous value.

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

Subtract from the current value, returning the previous value.

impl Atomic<u16>

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

Minimum with the current value.

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

Maximum with 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

Subtract from the current value, returning the previous value.

impl Atomic<i32>

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

Minimum with the current value.

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

Maximum with the current value.

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

Adds to the current value, returning the previous value.

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

Subtract from the current value, returning the previous value.

impl Atomic<u32>

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

Minimum with the current value.

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

Maximum with the current value.

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

Adds to the current value, returning the previous value.

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

Subtract from the current value, returning the previous value.

impl Atomic<i64>

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

Minimum with the current value.

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

Maximum with the current value.

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

Adds to the current value, returning the previous value.

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

Subtract from the current value, returning the previous value.

impl Atomic<u64>

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

Minimum with the current value.

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

Maximum with the current value.

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

Adds to the current value, returning the previous value.

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

Subtract from the current value, returning the previous value.

impl Atomic<isize>

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

Minimum with the current value.

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

Maximum with the current value.

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

Adds to the current value, returning the previous value.

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

Subtract from the current value, returning the previous value.

impl Atomic<usize>

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

Minimum with the current value.

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

Maximum with the current value.

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

Adds to the current value, returning the previous value.

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

Subtract from the current value, returning the previous value.

Trait Implementations

impl<T: Copy + Debug> Debug for Atomic<T>

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

Formats the value using the given formatter.

impl<T: Default> Default for Atomic<T>

fn default() -> Self

Returns the “default value” for a type.

impl<T> From<T> for Atomic<T>

fn from(value: T) -> Self

Converts to this type from the input type.

impl<T> Pointer for Atomic<*const T>

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

Formats the value using the given formatter.

impl<T> Pointer for Atomic<*mut T>

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

Formats the value using the given formatter.

impl<T: Copy + RefUnwindSafe> RefUnwindSafe for Atomic<T>

impl<T: Send> Sync for Atomic<T>