#[repr(transparent)]
pub struct Atomic<T> { /* private fields */ }
Expand description

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

Implementations

Creates a new Atomic.

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

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.

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.

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.

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.

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

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

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 Release or AcqRel and must be equivalent or weaker than the success ordering.

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 Release or AcqRel and must be equivalent or weaker than the success ordering. success ordering.

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 and must be equivalent to or weaker than the success ordering.

Examples
use atomic::{Atomic, Ordering};

let x = Atomic::new(7);
assert_eq!(x.fetch_update(Ordering::SeqCst, Ordering::SeqCst, |_| None), Err(7));
assert_eq!(x.fetch_update(Ordering::SeqCst, Ordering::SeqCst, |x| Some(x + 1)), Ok(7));
assert_eq!(x.fetch_update(Ordering::SeqCst, Ordering::SeqCst, |x| Some(x + 1)), Ok(8));
assert_eq!(x.load(Ordering::SeqCst), 9);

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.

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.

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.

Add to the current value, returning the previous value.

Subtract from the current value, returning the previous value.

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

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

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

Add to the current value, returning the previous value.

Subtract from the current value, returning the previous value.

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

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

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

Add to the current value, returning the previous value.

Subtract from the current value, returning the previous value.

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

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

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

Add to the current value, returning the previous value.

Subtract from the current value, returning the previous value.

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

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

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

Add to the current value, returning the previous value.

Subtract from the current value, returning the previous value.

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

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

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

Add to the current value, returning the previous value.

Subtract from the current value, returning the previous value.

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

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

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

Minimum with the current value.

Maximum with the current value.

Minimum with the current value.

Maximum with the current value.

Minimum with the current value.

Maximum with the current value.

Minimum with the current value.

Maximum with the current value.

Minimum with the current value.

Maximum with the current value.

Minimum with the current value.

Maximum with the current value.

Add to the current value, returning the previous value.

Subtract from the current value, returning the previous value.

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

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

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

Add to the current value, returning the previous value.

Subtract from the current value, returning the previous value.

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

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

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

Add to the current value, returning the previous value.

Subtract from the current value, returning the previous value.

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

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

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

Add to the current value, returning the previous value.

Subtract from the current value, returning the previous value.

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

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

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

Add to the current value, returning the previous value.

Subtract from the current value, returning the previous value.

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

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

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

Add to the current value, returning the previous value.

Subtract from the current value, returning the previous value.

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

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

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

Minimum with the current value.

Maximum with the current value.

Minimum with the current value.

Maximum with the current value.

Minimum with the current value.

Maximum with the current value.

Minimum with the current value.

Maximum with the current value.

Minimum with the current value.

Maximum with the current value.

Minimum with the current value.

Maximum with the current value.

Trait Implementations

Formats the value using the given formatter. Read more

Returns the “default value” for a type. Read more

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

Returns the argument unchanged.

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.