Struct Clock 

pub struct Clock {
    current: usize,
    total: usize,
}

A simulation clock that tracks steps over a fixed duration.

The Clock provides methods to advance time step-by-step or run a function at each time step until completion.

Examples

Note: vpp-sim currently ships as a binary-first crate; this snippet is illustrative.

use vpp_sim::sim::clock::Clock;

let mut clock = Clock::new(3);
let mut steps = Vec::new();

clock.run(|step| steps.push(step));
assert_eq!(steps, vec![0, 1, 2]);

Fields

current: usize

Current step of the simulation

total: usize

Total steps to run in the simulation

Implementations

impl Clock

pub fn new(total: usize) -> Self

Creates a new clock with a specified total number of steps.

Arguments

• total - The total number of steps the clock will run

pub fn tick(&mut self) -> Option<usize>

Advances the clock by one step.

Returns

• Some(step) - The current step number (starting from 0) before advancing
• None - If the clock has reached its total steps

pub fn run<F>(&mut self, f: F)

where F: FnMut(usize),

Runs a function for each remaining step in the clock.

This method will call the provided function with the current step number for each step until the clock completes all steps.

Arguments

• f - A function that takes the current step number as an argument