Struct HistoricalClock 

pub struct HistoricalClock { /* private fields */ }

A clock that replays historical time by walking through a specified interval.

The clock starts at the interval’s start time and advances in fixed time steps until reaching the end of the interval. Each call to cycle_time() advances the clock by one time step.

The instant component is adjusted so that the baseline instant represents the start of the historical interval, maintaining proper duration relationships.

Implementations

impl HistoricalClock

pub fn new(interval: Interval) -> Self

Create a new historical clock with a default 100μs time step

pub fn with_time_step(interval: Interval, time_step: Duration) -> Self

Create a new historical clock with a custom time step

pub fn is_exhausted(&self) -> bool

Check if the clock has exhausted the historical interval

pub fn current_time(&self) -> OffsetDateTime

Get the current position within the interval

pub fn interval(&self) -> &Interval

Get the interval being replayed

pub fn time_step(&self) -> Duration

Get the time step duration

pub fn reset(&mut self)

Reset the clock back to the start of the interval

Trait Implementations

impl Clock for HistoricalClock

fn cycle_time(&mut self) -> CycleTime

Get the current cycle time containing both monotonic and wall clock times.