Enum Ordering 

pub enum Ordering {
    Relaxed,
    Acquire,
    Release,
    AcqRel,
    SeqCst,
}

How strongly an atomic access or a barrier is ordered against everything around it.

The C11 memory model’s orderings, which gcc’s __atomic_ family took from the same place. This is spelled here rather than reused from the IR because nothing in this crate knows what an IR is, and the walk that builds one is where the two are put side by side.

memory_order_consume is not here. Every compiler in use today gives it the same code as acquire, C++17 discourages it, and a spelling of it that means acquire would be a name whose only effect is to make a reader think something was implemented. The number the source wrote is read and turned into Ordering::Acquire where it appears, and the fact that it was written is not carried any further.

Variants

Relaxed

Atomic, and ordered against nothing.

Acquire

Nothing after this moves before it.

Release

Nothing before this moves after it.

AcqRel

Both, which only a read-modify-write or a barrier can ask for.

SeqCst

Both, and one total order over every sequentially consistent operation in the program.

Implementations

impl Ordering

pub const fn as_str(self) -> &'static str

How the ordering is written in the typed tree’s textual form.

Trait Implementations

impl Clone for Ordering

fn clone(&self) -> Ordering

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for Ordering

impl Debug for Ordering

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

Formats the value using the given formatter.

impl Eq for Ordering

impl Ord for Ordering

fn cmp(&self, other: &Ordering) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for Ordering

fn eq(&self, other: &Ordering) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl PartialOrd for Ordering

fn partial_cmp(&self, other: &Ordering) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralPartialEq for Ordering