Struct Epoch 

pub struct Epoch { /* private fields */ }

Epoch is a unit of time that dictates the lifetime of retired memory regions.

The global epoch rotates 64 Epoch values in a range of [0..63], instead of monotonically increasing to reduce the memory footprint of the Epoch values.

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.

Examples

use sdd::Epoch;

let initial = Epoch::default();

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

pub const fn in_same_generation(self, other: Epoch) -> bool

Checks if the current Epoch is in the same generation as the given Epoch.

This operation is not commutative, e.g., a.in_same_generation(b) is not the same as b.in_same_generation(a). This returns true if the other Epoch is either the same with the current one, the next one, or the next one after that. The meaning of false returned by this method is that a memory region retired in the current Epoch will no longer be reachable in the other Epoch.

Examples

use sdd::Epoch;

let initial = Epoch::default();

let next_generation = initial.next_generation();
assert!(initial.in_same_generation(initial.next().next()));
assert!(!initial.in_same_generation(initial.next().next().next()));

pub const fn next(self) -> Epoch

Returns the next Epoch value.

Examples

use sdd::Epoch;

let initial = Epoch::default();

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

let next_prev = next.prev();
assert_eq!(initial, next_prev);

pub const fn prev(self) -> Epoch

Returns the previous Epoch value.

Examples

use sdd::Epoch;

let initial = Epoch::default();

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

let prev_next = prev.next();
assert_eq!(initial, prev_next);

Trait Implementations

impl Clone for Epoch

fn clone(&self) -> Epoch

Returns a duplicate 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 TryFrom<u8> for Epoch

type Error = Epoch

The type returned in the event of a conversion error.

fn try_from(value: u8) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for Epoch

impl Eq for Epoch

impl StructuralPartialEq for Epoch