vihaco_stdlib::clock

clock¶

vihaco_stdlib::clock

Reusable global-clock and timing vocabulary for vihaco runtimes.

GlobalClock is an ordered event queue. It owns modeled timeline state, but does not execute instructions, dispatch events, or know about the machine that owns it. A runtime can use the types in this module to build its own scheduling policy and root event loop.

classGlobalClock¶source

vihaco_stdlib::clock::GlobalClock

Bases: Default

Rust struct. A deterministic event queue ordered by global tick and insertion sequence.

pub struct GlobalClock<E>

source

methodis_empty¶source

vihaco_stdlib::clock::GlobalClock::is_empty

pub fn is_empty(&self) -> bool

Returns

bool

source

methodnew¶source

vihaco_stdlib::clock::GlobalClock::new

pub fn new() -> Self

Returns

Self

source

methodnow¶source

vihaco_stdlib::clock::GlobalClock::now

pub fn now(&self) -> GlobalTick

Returns

GlobalTick

source

methodpop_earliest¶source

vihaco_stdlib::clock::GlobalClock::pop_earliest

pub fn pop_earliest(&mut self) -> Option<(GlobalTick, E)>

Returns

Option<(GlobalTick, E)>

Removes the earliest event and advances the current global tick to it.

source

methodschedule_after¶source

vihaco_stdlib::clock::GlobalClock::schedule_after

Signature

pub fn schedule_after(&mut self, after: GlobalDuration, event: E) -> Result<(), ClockFault>

Parameters

Name	Type	Description
after	GlobalDuration
event	E

Returns

Result<(), ClockFault>

Converts relative work into an absolute global tick.

source

methodschedule_at¶source

vihaco_stdlib::clock::GlobalClock::schedule_at

Signature

pub fn schedule_at(&mut self, tick: GlobalTick, event: E) -> Result<(), ClockFault>

Parameters

Name	Type	Description
tick	GlobalTick
event	E

Returns

Result<(), ClockFault>

Inserts owned scheduling work at an absolute global tick.

source

classGlobalDuration¶source

vihaco_stdlib::clock::GlobalDuration

Bases: Debug, Clone, Copy, StructuralPartialEq, PartialEq, Eq, PartialOrd, Ord

Rust struct. A distance between two positions on the modeled global timeline.

pub struct GlobalDuration

Fields

Name	Type	Description
0	u64

source

classGlobalTick¶source

vihaco_stdlib::clock::GlobalTick

Bases: Debug, Clone, Copy, StructuralPartialEq, PartialEq, Eq, PartialOrd, Ord

Rust struct. An absolute position on the modeled global timeline.

pub struct GlobalTick

Fields

Name	Type	Description
0	u64

source

methodchecked_add¶source

vihaco_stdlib::clock::GlobalTick::checked_add

Signature

pub fn checked_add(self, duration: GlobalDuration) -> Result<Self, ClockFault>

Parameters

Name	Type	Description
duration	GlobalDuration

Returns

Result<Self, ClockFault>

source

classGlobalTicksPerLocalCycle¶source

vihaco_stdlib::clock::GlobalTicksPerLocalCycle

Bases: Debug, Clone, Copy, StructuralPartialEq, PartialEq, Eq, PartialOrd, Ord

Rust struct. The conversion ratio from local cycles to global ticks.

pub struct GlobalTicksPerLocalCycle

Fields

Name	Type	Description
0	u64

source

methodnew¶source

vihaco_stdlib::clock::GlobalTicksPerLocalCycle::new

pub fn new(value: u64) -> Result<Self, ClockFault>

Parameters

Name	Type	Description
value	u64

Returns

Result<Self, ClockFault>

source

classLocalCycles¶source

vihaco_stdlib::clock::LocalCycles

Bases: Debug, Clone, Copy, StructuralPartialEq, PartialEq, Eq, PartialOrd, Ord

Rust struct. Work measured in the local clock domain of a component.

pub struct LocalCycles

Fields

Name	Type	Description
0	u64

source

methodchecked_add¶source

vihaco_stdlib::clock::LocalCycles::checked_add

pub fn checked_add(self, other: Self) -> Result<Self, ClockFault>

Parameters

Name	Type	Description
other	Self

Returns

Result<Self, ClockFault>

source

methodchecked_mul¶source

vihaco_stdlib::clock::LocalCycles::checked_mul

Signature

pub fn checked_mul(self, ratio: GlobalTicksPerLocalCycle) -> Result<GlobalDuration, ClockFault>

Parameters

Name	Type	Description
ratio	GlobalTicksPerLocalCycle

Returns

Result<GlobalDuration, ClockFault>

source

classSchedule¶source

vihaco_stdlib::clock::Schedule

Bases: Debug, StructuralPartialEq, PartialEq, Eq

Rust struct. Owned scheduling work returned by a clocked component.

pub struct Schedule<E>

Fields

Name	Type	Description
at	GlobalTick
event	E

source

classClockFault¶source

vihaco_stdlib::clock::ClockFault

Bases: Debug, StructuralPartialEq, PartialEq, Eq, Display, Error

Rust enum. Errors produced while validating or advancing a modeled clock.

pub enum ClockFault

Variants

Name	Type	Description
ZeroTickRatio	—
LocalCycleOverflow	—
DurationOverflow	—
GlobalTickOverflow	—
SequenceOverflow	—
SchedulingInPast	—

source

classClockedComponent¶source

vihaco_stdlib::clock::ClockedComponent

Rust trait. Generic boundary for a component that participates in a global event loop.

pub trait ClockedComponent: Sized

Associated items

Name	Type	Description
Event	type Event	associated type
Completion	type Completion	associated type
Fault	type Fault	associated type

source

methodnext_boundary_at¶source

vihaco_stdlib::clock::ClockedComponent::next_boundary_at

Signature

fn next_boundary_at(&self, global_tick: GlobalTick, ticks_per_local_cycle: GlobalTicksPerLocalCycle) -> Result<GlobalTick, <Self as >::Fault>

Parameters

Name	Type	Description
global_tick	GlobalTick
ticks_per_local_cycle	GlobalTicksPerLocalCycle

Returns

Result<GlobalTick, <Self as >::Fault>

source

methodresume¶source

vihaco_stdlib::clock::ClockedComponent::resume

Signature

fn resume(&mut self, completion: <Self as >::Completion, global_tick: GlobalTick, ticks_per_local_cycle: GlobalTicksPerLocalCycle) -> Result<Option<Schedule<<Self as >::Event>>, <Self as >::Fault>

Parameters

Name	Type	Description
completion	<Self as >::Completion
global_tick	GlobalTick
ticks_per_local_cycle	GlobalTicksPerLocalCycle

Returns

Result<Option<Schedule<<Self as >::Event>>, <Self as >::Fault>

source

methodstep_at¶source

vihaco_stdlib::clock::ClockedComponent::step_at

Signature

fn step_at(&mut self, global_tick: GlobalTick, ticks_per_local_cycle: GlobalTicksPerLocalCycle) -> Result<Option<Schedule<<Self as >::Event>>, <Self as >::Fault>

Parameters

Name	Type	Description
global_tick	GlobalTick
ticks_per_local_cycle	GlobalTicksPerLocalCycle

Returns

Result<Option<Schedule<<Self as >::Event>>, <Self as >::Fault>

source

classTimedInstruction¶source

vihaco_stdlib::clock::TimedInstruction

Rust trait. Runtime instructions provide the local duration of their operation.

pub trait TimedInstruction

source

methodlocal_cycles¶source

vihaco_stdlib::clock::TimedInstruction::local_cycles

fn local_cycles(&self) -> LocalCycles

Returns

LocalCycles

source