Struct Epoch 

pub struct Epoch {
    pub id: EpochId,
    pub state: EpochState,
    pub started_at: Time,
    pub expected_end: Time,
    pub ended_at: Option<Time>,
    pub config: EpochConfig,
    pub operation_count: u64,
    pub metadata: DetHashMap<String, String>,
}

Full epoch state with metadata.

Fields

id: EpochId

Unique identifier.

state: EpochState

Current state.

started_at: Time

When this epoch started.

expected_end: Time

When this epoch is expected to end.

ended_at: Option<Time>

When this epoch actually ended (if ended).

config: EpochConfig

Configuration for this epoch.

operation_count: u64

Number of operations executed in this epoch.

metadata: DetHashMap<String, String>

Custom metadata.

Implementations

impl Epoch

pub fn new(id: EpochId, started_at: Time, config: EpochConfig) -> Self

Creates a new epoch.

pub fn genesis(config: EpochConfig) -> Self

Creates the genesis epoch.

pub fn duration(&self, now: Time) -> Duration

Returns the duration of this epoch (or elapsed time if still active).

pub fn is_overdue(&self, now: Time) -> bool

Returns true if the epoch has exceeded its maximum duration.

pub fn can_transition(&self, now: Time) -> bool

Returns true if the epoch can transition (met minimum duration).

pub fn remaining(&self, now: Time) -> Option<Duration>

Returns the time remaining until expected end.

pub fn record_operation(&mut self)

Records an operation.

pub fn begin_ending(&mut self, _now: Time) -> Result<(), Box<Error>>

Begins the ending phase (grace period).

pub fn complete(&mut self, now: Time) -> Result<(), Box<Error>>

Completes the epoch.

pub fn set_metadata(&mut self, key: impl Into<String>, value: impl Into<String>)

Adds metadata to the epoch.

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.