Struct EpochSchedule

#[repr(C)]
pub struct EpochSchedule {
    pub slots_per_epoch: u64,
    pub leader_schedule_slot_offset: u64,
    pub warmup: bool,
    pub first_normal_epoch: u64,
    pub first_normal_slot: u64,
}

Fields

slots_per_epoch: u64

The maximum number of slots in each epoch.

leader_schedule_slot_offset: u64

A number of slots before beginning of an epoch to calculate a leader schedule for that epoch.

warmup: bool

Whether epochs start short and grow.

first_normal_epoch: u64

The first epoch after the warmup period.

Basically: log2(slots_per_epoch) - log2(MINIMUM_SLOTS_PER_EPOCH).

first_normal_slot: u64

The first slot after the warmup period.

Basically: MINIMUM_SLOTS_PER_EPOCH * (2.pow(first_normal_epoch) - 1).

Implementations

impl EpochSchedule

pub fn new(slots_per_epoch: u64) -> Self

pub fn without_warmup() -> Self

pub fn custom( slots_per_epoch: u64, leader_schedule_slot_offset: u64, warmup: bool, ) -> Self

pub fn get_slots_in_epoch(&self, epoch: u64) -> u64

get the length of the given epoch (in slots)

pub fn get_leader_schedule_epoch(&self, slot: u64) -> u64

get the epoch for which the given slot should save off information about stakers

pub fn get_epoch(&self, slot: u64) -> u64

get epoch for the given slot

pub fn get_epoch_and_slot_index(&self, slot: u64) -> (u64, u64)

get epoch and offset into the epoch for the given slot

pub fn get_first_slot_in_epoch(&self, epoch: u64) -> u64

pub fn get_last_slot_in_epoch(&self, epoch: u64) -> u64

Trait Implementations

impl Clone for EpochSchedule

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for EpochSchedule

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

Formats the value using the given formatter.

impl Default for EpochSchedule

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for EpochSchedule

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

impl StructuralPartialEq for EpochSchedule