Struct debra_common::epoch::Epoch

pub struct Epoch(_);

A monotonically increasing epoch counter with wrapping overflow behaviour.

Methods

impl Epoch

pub fn new() -> Self

Creates a new Epoch starting at zero.

pub fn relative_age(
    self,
    global_epoch: Epoch
) -> Result<PossibleAge, Undetermined>

Returns the PossibleAge of the epoch relative to global_epoch.

Since the global epoch is explicitly allowed to wrap around, it is not possible to unambiguously determine the relative age of an epoch. However, since epochs are monotonically increasing it is certain that any previously observed epoch must be older of equal than the global epoch. Consequently, it is possible to determine if an epoch could be within the critical range of two epochs, during which reclamation of records must be avoided, and is in order to be conservative.

Trait Implementations

impl Ord for Epoch

fn cmp(&self, other: &Epoch) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

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 Copy for Epoch

impl Default for Epoch

fn default() -> Epoch

Returns the "default value" for a type.

impl PartialEq<Epoch> for Epoch

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl Eq for Epoch

impl PartialOrd<Epoch> for Epoch

fn partial_cmp(&self, other: &Epoch) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Debug for Epoch

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

Formats the value using the given formatter.

impl Display for Epoch

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

Formats the value using the given formatter.

impl Add<usize> for Epoch

type Output = Self

The resulting type after applying the + operator.

fn add(self, rhs: usize) -> Self::Output

Performs the + operation.

impl Sub<usize> for Epoch

type Output = Self

The resulting type after applying the - operator.

fn sub(self, rhs: usize) -> Self::Output

Performs the - operation.