Trait crossbeam_utils::atomic::AtomicConsume

source ·
pub trait AtomicConsume {
    type Val;

    // Required method
    fn load_consume(&self) -> Self::Val;
}
Expand description

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

Required Associated Types§

source

type Val

Type returned by load_consume.

Required Methods§

source

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§

source§

impl AtomicConsume for AtomicBool

source§

type Val = bool

source§

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

source§

impl AtomicConsume for AtomicI8

source§

type Val = i8

source§

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

source§

impl AtomicConsume for AtomicI16

source§

type Val = i16

source§

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

source§

impl AtomicConsume for AtomicI32

source§

type Val = i32

source§

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

source§

impl AtomicConsume for AtomicI64

source§

type Val = i64

source§

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

source§

impl AtomicConsume for AtomicIsize

source§

type Val = isize

source§

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

source§

impl AtomicConsume for AtomicU8

source§

type Val = u8

source§

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

source§

impl AtomicConsume for AtomicU16

source§

type Val = u16

source§

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

source§

impl AtomicConsume for AtomicU32

source§

type Val = u32

source§

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

source§

impl AtomicConsume for AtomicU64

source§

type Val = u64

source§

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

source§

impl AtomicConsume for AtomicUsize

source§

type Val = usize

source§

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

source§

impl<T> AtomicConsume for AtomicPtr<T>

source§

type Val = *mut T

source§

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

Implementors§