core::sync::atomic::Ordering - Rust
Description: API documentation for the Rust `Ordering` enum in crate `core`.
Keywords: rust, rustlang, rust-lang, Ordering

# 1.0.0[−][src]Enum core::sync::atomic::Ordering

    #[non_exhaustive]
    pub enum Ordering {
        Relaxed,
        Release,
        Acquire,
        AcqRel,
        SeqCst,
    }

Atomic memory orderings

Memory orderings specify the way atomic operations synchronize memory. In its weakest `Relaxed`, only the memory directly touched by the operation is synchronized. On the other hand, a store-load pair of `SeqCst` operations synchronize other memory while additionally preserving a total order of such operations across all threads.

Rust's memory orderings are the same as LLVM's.

For more information see the nomicon.

## Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.
`Relaxed`

No ordering constraints, only atomic operations.

Corresponds to LLVM's `Monotonic` ordering.

`Release`

When coupled with a store, all previous operations become ordered before any load of this value with `Acquire` (or stronger) ordering. In particular, all previous writes become visible to all threads that perform an `Acquire` (or stronger) load of this value.

Notice that using this ordering for an operation that combines loads and stores leads to a `Relaxed` load operation!

This ordering is only applicable for operations that can perform a store.

Corresponds to LLVM's `Release` ordering.

`Acquire`

When coupled with a load, if the loaded value was written by a store operation with `Release` (or stronger) ordering, then all subsequent operations become ordered after that store. In particular, all subsequent loads will see data written before the store.

Notice that using this ordering for an operation that combines loads and stores leads to a `Relaxed` store operation!

This ordering is only applicable for operations that can perform a load.

Corresponds to LLVM's `Acquire` ordering.

`AcqRel`

Has the effects of both `Acquire` and `Release` together: For loads it uses `Acquire` ordering. For stores it uses the `Release` ordering.

Notice that in the case of `compare_and_swap`, it is possible that the operation ends up not performing any store and hence it has just `Acquire` ordering. However, `AcqRel` will never perform `Relaxed` accesses.

This ordering is only applicable for operations that combine both loads and stores.

Corresponds to LLVM's `AcquireRelease` ordering.

`SeqCst`

Like `Acquire`/`Release`/`AcqRel` (for load, store, and load-with-store operations, respectively) with the additional guarantee that all threads see all sequentially consistent operations in the same order.

Corresponds to LLVM's `SequentiallyConsistent` ordering.

## Trait Implementations

### `impl Copy for Ordering`[src]

### `impl PartialEq<Ordering> for Ordering`[src]

#### `fn eq(&self, other: &Ordering) -> bool`[src]

This method tests for `self` and `other` values to be equal, and is used by `==`. Read more

#### `
#[must_use]
fn ne(&self, other: &Rhs) -> bool`[src]

This method tests for `!=`.

### `impl Eq for Ordering`[src]

### `impl Clone for Ordering`[src]

#### `fn clone(&self) -> Ordering`[src]

Returns a copy of the value. Read more

#### `fn clone_from(&mut self, source: &Self)`[src]

Performs copy-assignment from `source`. Read more

### `impl Hash for Ordering`[src]

#### `fn hash<__H: Hasher>(&self, state: &mut __H)`[src]

Feeds this value into the given [`Hasher`]. Read more

#### `fn hash_slice<H: Hasher>(data: &[Self], state: &mut H) where
Self: Sized,` 1.3.0[src]

Feeds a slice of this type into the given [`Hasher`]. Read more

### `impl Debug for Ordering`[src]

#### `fn fmt(&self, f: &mut Formatter) -> Result`[src]

Formats the value using the given formatter. Read more

## Auto Trait Implementations

### `impl Send for Ordering`

### `impl Sync for Ordering`

## Blanket Implementations

### `impl<T, U> Into<U> for T where
U: From<T>,` [src]

#### `fn into(Self) -> U`[src]

Performs the conversion.

### `impl<T> From<T> for T`[src]

#### `fn from(T) -> T`[src]

Performs the conversion.

### `impl<T, U> TryInto<U> for T where
U: TryFrom<T>,` [src]

#### `type Error = <U as TryFrom<T>>::Error`

The type returned in the event of a conversion error.

#### `fn try_into(Self) -> Result<U, <U as TryFrom<T>>::Error>`[src]

Performs the conversion.

### `impl<T, U> TryFrom<U> for T where
U: Into<T>,` [src]

#### `type Error = Infallible`

The type returned in the event of a conversion error.

#### `fn try_from(U) -> Result<T, <T as TryFrom<U>>::Error>`[src]

Performs the conversion.

### `impl<T> Borrow<T> for T where
T: ?Sized,` [src]

#### `fn borrow(&Self) -> &T`[src]

Immutably borrows from an owned value. Read more

### `impl<T> BorrowMut<T> for T where
T: ?Sized,` [src]

#### `fn borrow_mut(&mut Self) -> &mut T`[src]

Mutably borrows from an owned value. Read more

### `impl<T> Any for T where
T: 'static + ?Sized,` [src]

#### `fn type_id(&Self) -> TypeId`[src]

Gets the `TypeId` of `self`. Read more

# Help

## Keyboard Shortcuts

`?`
  Show this help dialog
`S`
  Focus the search field
`↑`
  Move up in search results
`↓`
  Move down in search results
`↹`
  Switch tab
`⏎`
  Go to active search result
`+`
  Expand all sections
`-`
  Collapse all sections

## Search Tricks

Prefix searches with a type followed by a colon (e.g., `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct`, `enum`, `trait`, `type`, `macro`, and `const`.

Search functions by type signature (e.g., `vec -> usize` or `* -> vec`)

Search multiple things at once by splitting your query with comma (e.g., `str,u8` or `String,struct:Vec,test`)