Struct Epoch 

pub struct Epoch(/* private fields */);

Represents a distinct segment of a contiguous sequence of views.

An epoch increments when the validator set changes, providing a reconfiguration boundary. All consensus operations within an epoch use the same validator set.

Implementations

impl Epoch

pub const fn zero() -> Self

Returns epoch zero.

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

Creates a new epoch from a u64 value.

pub const fn get(self) -> u64

Returns the underlying u64 value.

pub const fn is_zero(self) -> bool

Returns true if this is epoch zero.

pub const fn next(self) -> Self

Returns the next epoch.

Panics

Panics if the epoch would overflow u64::MAX. In practice, this is extremely unlikely to occur during normal operation.

pub fn previous(self) -> Option<Self>

Returns the previous epoch, or None if this is epoch zero.

Unlike Epoch::next(), this returns an Option since reaching epoch zero is common, whereas overflowing u64::MAX is not expected in normal operation.

pub const fn saturating_add(self, delta: EpochDelta) -> Self

Adds a delta to this epoch, saturating at u64::MAX.

pub fn checked_sub(self, delta: EpochDelta) -> Option<Self>

Subtracts a delta from this epoch, returning None if it would underflow.

pub const fn saturating_sub(self, delta: EpochDelta) -> Self

Subtracts a delta from this epoch, saturating at zero.

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

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

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

Formats the value using the given formatter.

impl EncodeSize for Epoch

fn encode_size(&self) -> usize

Returns the encoded size of this value (in bytes).

fn encode_inline_size(&self) -> usize

Returns the encoded size excluding bytes passed to BufsMut::push during Write::write_bufs. Used to size the working buffer for inline writes. Override alongside Write::write_bufs for types where large Bytes fields go via push; failing to do so will over-allocate.

impl Eq for Epoch

impl From<Epoch> for U64

fn from(epoch: Epoch) -> Self

Converts to this type from the input type.

impl Hash for Epoch

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 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

Equality operator ==.

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

Inequality operator !=.

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

type Cfg = ()

The Cfg type parameter allows passing configuration during the read process. This is crucial for safely decoding untrusted data, for example, by providing size limits for collections or strings.

fn read_cfg(buf: &mut impl Buf, _cfg: &Self::Cfg) -> Result<Self, Error>

Reads a value from the buffer using the provided configuration cfg.

impl StructuralPartialEq for Epoch

impl TracedExt for Epoch

Available on non-WebAssembly only.

fn traced(self) -> i64

Returns self as an i64 for use as a tracing field value.

impl Write for Epoch

fn write(&self, buf: &mut impl BufMut)

Writes the binary representation of self to the provided buffer buf.

fn write_bufs(&self, buf: &mut impl BufsMut)

Writes to a BufsMut, allowing existing Bytes chunks to be appended via BufsMut::push instead of written inline. Must encode to the same format as Write::write. Defaults to Write::write.