Struct atomic::Atomic

pub struct Atomic<T: Copy> { /* fields omitted */ }

A generic atomic wrapper type which allows an object to be safely shared between threads.

Methods

impl<T: Copy> Atomic<T>

fn new(v: T) -> Atomic<T>

Creates a new Atomic.

fn is_lock_free() -> bool

Checks if Atomic objects of this type are lock-free.

If an Atomic is not lock-free then it may be implemented using locks internally, which makes it unsuitable for some situations (such as communicating with a signal handler).

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

Loads a value from the Atomic.

load takes an Ordering argument which describes the memory ordering of this operation.

Panics

Panics if order is Release or AcqRel.

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

Stores a value into the Atomic.

store takes an Ordering argument which describes the memory ordering of this operation.

Panics

Panics if order is Acquire or AcqRel.

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

Stores a value into the Atomic, returning the old value.

swap takes an Ordering argument which describes the memory ordering of this operation.

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

compare_exchange takes two Ordering arguments to describe the memory ordering of this operation. The first describes the required ordering if the operation succeeds while the second describes the required ordering when the operation fails. The failure ordering can't be Acquire or AcqRel and must be equivalent or weaker than the success ordering.

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 takes two Ordering arguments to describe the memory ordering of this operation. The first describes the required ordering if the operation succeeds while the second describes the required ordering when the operation fails. The failure ordering can't be Acquire or AcqRel and must be equivalent or weaker than the success ordering. success ordering.

impl Atomic<bool>

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

Logical "and" with a boolean value.

Performs a logical "and" operation on the current value and the argument val, and sets the new value to the result.

Returns the previous value.

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

Logical "or" with a boolean value.

Performs a logical "or" operation on the current value and the argument val, and sets the new value to the result.

Returns the previous value.

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

Logical "xor" with a boolean value.

Performs a logical "xor" operation on the current value and the argument val, and sets the new value to the result.

Returns the previous value.

impl Atomic<i8>

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

Add to the current value, returning the previous value.

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

Subtract from the current value, returning the previous value.

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

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

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

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

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

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

impl Atomic<u8>

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

Add to the current value, returning the previous value.

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

Subtract from the current value, returning the previous value.

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

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

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

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

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

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

impl Atomic<i16>

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

Add to the current value, returning the previous value.

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

Subtract from the current value, returning the previous value.

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

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

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

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

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

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

impl Atomic<u16>

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

Add to the current value, returning the previous value.

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

Subtract from the current value, returning the previous value.

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

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

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

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

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

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

impl Atomic<i32>

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

Add to the current value, returning the previous value.

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

Subtract from the current value, returning the previous value.

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

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

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

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

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

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

impl Atomic<u32>

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

Add to the current value, returning the previous value.

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

Subtract from the current value, returning the previous value.

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

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

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

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

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

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

impl Atomic<i64>

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

Add to the current value, returning the previous value.

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

Subtract from the current value, returning the previous value.

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

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

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

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

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

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

impl Atomic<u64>

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

Add to the current value, returning the previous value.

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

Subtract from the current value, returning the previous value.

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

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

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

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

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

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

Trait Implementations

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

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

fn default() -> Self

Returns the "default value" for a type.

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

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

Formats the value using the given formatter.