Struct crossbeam_epoch::epoch::AtomicEpoch

pub(crate) struct AtomicEpoch {
    data: AtomicUsize,
}

An atomic value that holds an Epoch.

Fields

data: AtomicUsize

Since Epoch is just a wrapper around usize, an AtomicEpoch is similarly represented using an AtomicUsize.

Implementations

impl AtomicEpoch

pub(crate) fn new(epoch: Epoch) -> Self

Creates a new atomic epoch.

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

Loads a value from the atomic epoch.

pub(crate) fn store(&self, epoch: Epoch, ord: Ordering)

Stores a value into the atomic epoch.

pub(crate) fn compare_exchange( &self, current: Epoch, new: Epoch, success: Ordering, failure: Ordering ) -> Result<Epoch, Epoch>

Stores a value into the atomic epoch if the current value is the same as current.

The return value is a result indicating whether the new value was written and containing the previous value. On success this value is guaranteed to be equal to current.

This method takes two Ordering arguments to describe the memory ordering of this operation. success describes the required ordering for the read-modify-write operation that takes place if the comparison with current succeeds. failure describes the required ordering for the load operation that takes place when the comparison fails. Using Acquire as success ordering makes the store part of this operation Relaxed, and using Release makes the successful load Relaxed. The failure ordering can only be SeqCst, Acquire or Relaxed and must be equivalent to or weaker than the success ordering.

Trait Implementations

impl Debug for AtomicEpoch

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

Formats the value using the given formatter.

impl Default for AtomicEpoch

fn default() -> AtomicEpoch

Returns the “default value” for a type.