Struct EpochId 

#[repr(transparent)]
pub struct EpochId(pub u64);

Identifies an epoch for memory management.

Think of epochs like garbage collection generations. When all readers from an old epoch finish, we can reclaim that memory. You usually don’t interact with epochs directly - they’re managed by the transaction system.

Tuple Fields

0: u64

Implementations

impl EpochId

pub const INITIAL: Self

The initial epoch (epoch 0).

pub const PENDING: Self

Sentinel epoch for uncommitted transactional versions.

Versions created inside an active (not yet committed) transaction use this value as their created_epoch. Because PENDING > any_real_epoch, is_visible_at(real_epoch) returns false, preventing dirty reads. On commit, the session finalizes these to the actual commit epoch.

pub const fn new(id: u64) -> Self

Creates a new EpochId from a raw u64 value.

pub const fn as_u64(&self) -> u64

Returns the raw u64 value.

pub const fn next(&self) -> Self

Returns the next epoch ID.

pub const fn is_visible_at(&self, viewing_epoch: Self) -> bool

Checks if this epoch is visible at the given epoch.

An epoch is visible if it was created before or at the viewing epoch.

Trait Implementations

impl Clone for EpochId

fn clone(&self) -> EpochId

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EpochId

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

Formats the value using the given formatter.

impl Default for EpochId

fn default() -> EpochId

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for EpochId

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for EpochId

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

Formats the value using the given formatter.

impl From<EpochId> for u64

fn from(id: EpochId) -> Self

Converts to this type from the input type.

impl From<u64> for EpochId

fn from(id: u64) -> Self

Converts to this type from the input type.

impl Hash for EpochId

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for EpochId

fn cmp(&self, other: &EpochId) -> 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 EpochId

fn eq(&self, other: &EpochId) -> 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 EpochId

fn partial_cmp(&self, other: &EpochId) -> 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 Serialize for EpochId

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for EpochId

impl Eq for EpochId

impl StructuralPartialEq for EpochId