Struct Epoch

pub(crate) struct Epoch {
    data: usize,
}

An epoch that can be marked as pinned or unpinned.

Internally, the epoch is represented as an integer that wraps around at some unspecified point and a flag that represents whether it is pinned or unpinned.

Fields

data: usize

The least significant bit is set if pinned. The rest of the bits hold the epoch.

Implementations

impl Epoch

pub(crate) fn starting() -> Self

Returns the starting epoch in unpinned state.

pub(crate) fn wrapping_sub(self, rhs: Self) -> isize

Returns the number of epochs self is ahead of rhs.

Internally, epochs are represented as numbers in the range (isize::MIN / 2) .. (isize::MAX / 2), so the returned distance will be in the same interval.

pub(crate) fn is_pinned(self) -> bool

Returns true if the epoch is marked as pinned.

pub(crate) fn pinned(self) -> Epoch

Returns the same epoch, but marked as pinned.

pub(crate) fn unpinned(self) -> Epoch

Returns the same epoch, but marked as unpinned.

pub(crate) fn successor(self) -> Epoch

Returns the successor epoch.

The returned epoch will be marked as pinned only if the previous one was as well.

Trait Implementations

impl Clone for Epoch

fn clone(&self) -> Epoch

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Epoch

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

Formats the value using the given formatter.

impl Default for Epoch

fn default() -> Epoch

Returns the “default value” for a type.

impl PartialEq for Epoch

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for Epoch

impl Eq for Epoch

impl StructuralPartialEq for Epoch