Struct chain_time::timeframe::TimeFrame

pub struct TimeFrame {
    timeline: Timeline,
    pub(crate) slot_offset: Slot,
    slot_duration: SlotDuration,
}

Time frame which is a timeline that is configured to be split in discrete slots

Fields

timeline: Timeline

slot_offset: Slot

slot_duration: SlotDuration

Implementations

impl TimeFrame

pub fn new(timeline: Timeline, per_slot: SlotDuration) -> Self

Create a new time frame with a specific slot size

0        1        2        3        4        5
x--------x--------x--------x--------x--------x  frame ticking at per_slot

^
|
timeline

pub fn change_frame(&self, slot: Slot, duration_per_slot: SlotDuration) -> Self

Change time frame at a specific slot

Note this also change the beginning of this time frame, to start

0        1        2        3        4        5
x--------x--------┳--------x--------x--------x  frame ticking at SlotDuration::from_secs(9)
                  |
                  ┕---x---x---x---x---x         returned frame
                  2   3   4   5   6   7
                  ↑
                  |
                  frame.change_frame(Slot(2), SlotDuration::from_secs(4))

pub fn slot0(&self) -> Slot

The current slot offset

pub fn slot_at_precise(&self, at: &SystemTime) -> Option<SlotAndDuration>

Given a system time get the slot and associated duration leftover

pub fn slot_at(&self, at: &SystemTime) -> Option<Slot>

Get the slot associated with the given system time.

It returns None if the system time doesn’t represent a valid slot in this time frame, for example if the system time is before the time frame starting point.

pub fn slot_to_systemtime(&self, slot: Slot) -> Option<SystemTime>

Get the system time associated with a slot on a specific timeframe

Note if the slot is not supposed to be in this reference frame, then None is returned

pub fn slot_duration(&self) -> u64

Returns slot duration value.

Trait Implementations

impl Clone for TimeFrame

fn clone(&self) -> TimeFrame

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TimeFrame

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

Formats the value using the given formatter.