Trait crossbeam_utils::atomic::AtomicConsume

pub trait AtomicConsume {
    type Val;
    fn load_consume(&self) -> Self::Val;
}

Trait which allows reading from primitive atomic types with “consume” ordering.

Associated Types

type Val

Type returned by load_consume.

Required methods

fn load_consume(&self) -> Self::Val

Loads a value from the atomic using a “consume” memory ordering.

This is similar to the “acquire” ordering, except that an ordering is only guaranteed with operations that “depend on” the result of the load. However consume loads are usually much faster than acquire loads on architectures with a weak memory model since they don’t require memory fence instructions.

The exact definition of “depend on” is a bit vague, but it works as you would expect in practice since a lot of software, especially the Linux kernel, rely on this behavior.

This is currently only implemented on ARM and AArch64, where a fence can be avoided. On other architectures this will fall back to a simple load(Ordering::Acquire).

Implementations on Foreign Types

impl AtomicConsume for AtomicBool

type Val = bool

fn load_consume(&self) -> Self::Val

impl AtomicConsume for AtomicUsize

type Val = usize

fn load_consume(&self) -> Self::Val

impl AtomicConsume for AtomicIsize

type Val = isize

fn load_consume(&self) -> Self::Val

impl AtomicConsume for AtomicU8

type Val = u8

fn load_consume(&self) -> Self::Val

impl AtomicConsume for AtomicI8

type Val = i8

fn load_consume(&self) -> Self::Val

impl AtomicConsume for AtomicU16

type Val = u16

fn load_consume(&self) -> Self::Val

impl AtomicConsume for AtomicI16

type Val = i16

fn load_consume(&self) -> Self::Val

impl AtomicConsume for AtomicU32

type Val = u32

fn load_consume(&self) -> Self::Val

impl AtomicConsume for AtomicI32

type Val = i32

fn load_consume(&self) -> Self::Val

impl AtomicConsume for AtomicU64

type Val = u64

fn load_consume(&self) -> Self::Val

impl AtomicConsume for AtomicI64

type Val = i64

fn load_consume(&self) -> Self::Val

impl<T> AtomicConsume for AtomicPtr<T>

type Val = *mut T

fn load_consume(&self) -> Self::Val

Implementors