Struct debra_common::epoch::AtomicEpoch

pub struct AtomicEpoch(_);

An atomic and concurrently accessible Epoch.

Methods

impl AtomicEpoch

pub const fn new() -> Self

Creates a new AtomicEpoch starting at zero.

pub fn load(&self, order: Ordering) -> Epoch

Loads the Epoch value.

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

Panics

Panics if order is Release or AcqRel.

pub fn compare_and_swap(
    &self,
    current: Epoch,
    new: Epoch,
    order: Ordering
) -> Epoch

Stores a value into the Epoch if the current value is equal to current.

The return value is always the previous value. If it is equal to current, then the value was updated.

compare_and_swap also takes an Ordering argument, which describes the memory ordering of this operation. Notice that even when using AcqRel, the operation might fail and hence just perform an Acquire load, but not have Release semantics. Using Acquire makes the store part of this operation Relaxed, if it happens, and using Release makes the load part Relaxed.

Trait Implementations

impl Debug for AtomicEpoch

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

Formats the value using the given formatter.

impl Display for AtomicEpoch

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

Formats the value using the given formatter.