Struct Epoch

pub struct Epoch { /* private fields */ }

Epoch represents the period of time the global epoch value stays the same.

Epoch rotates u8 values in a range of [0..3] while the crate itself functions correctly if the range is limited to [0..2]. The one additional state is useful for users to determine whether a certain memory chunk can be deallocated or not by using values returned from Guard::epoch, e.g., if an Owned was retired in epoch 1, then the Owned will become completely unreachable in epoch 0.

Implementations

impl Epoch

pub const fn next_generation(self) -> Epoch

Returns a future Epoch when the current readers will not be present.

The current Epoch may lag behind the global epoch value by 1, therefore this method returns an Epoch three epochs next to self.

use sdd::Epoch;

let initial = Epoch::default();

let next_generation = initial.next_generation();
assert_eq!(next_generation, initial.next().next().next());

pub const fn next(self) -> Epoch

Returns the next Epoch value.

use sdd::Epoch;

let initial = Epoch::default();

let next = initial.next();
assert!(initial < next);

let next_next = next.next();
assert!(next < next_next);

pub const fn prev(self) -> Epoch

Returns the previous Epoch value.

use sdd::Epoch;

let initial = Epoch::default();

let prev = initial.prev();
assert!(initial < prev);

let prev_prev = prev.prev();
assert!(prev_prev < prev);

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 From<Epoch> for u8

fn from(epoch: Epoch) -> Self

Converts to this type from the input type.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

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 PartialOrd 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: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Copy for Epoch

impl Eq for Epoch

impl StructuralPartialEq for Epoch