Struct Clock 

pub struct Clock { /* private fields */ }

Named clock with a ClockDomain and a ClockChart, the unit of clock math in this crate.

A clock converts between Instants and ClockIndexes, and mints the kernel Tick / Expr forms that carry a clock index across the runtime.

Examples

use sim_kernel::Symbol;
use sim_lib_stream_clock::{Clock, ClockChart, ClockIndex};

let clock = Clock::frame(Symbol::new("audio"), 48_000)?;
assert!(matches!(clock.chart(), ClockChart::Frames { frames_per_second: 48_000 }));
let instant = clock.instant_for_index(ClockIndex::new(48_000))?;
assert_eq!(instant.numerator(), 1);
assert_eq!(instant.denominator(), 1);

Implementations

impl Clock

pub fn frame(id: Symbol, frames_per_second: u64) -> Result<Self>

Builds a frame clock in the ClockDomain::Sample domain.

Returns an error when frames_per_second is zero.

pub fn frame_with_domain( id: Symbol, domain: ClockDomain, frames_per_second: u64, ) -> Result<Self>

Builds a frame clock in an explicit domain.

Returns an error when domain is ClockDomain::MidiTick (which requires a MIDI chart) or when frames_per_second is zero.

pub fn midi(id: Symbol, tpq: u32, tempo_map: TempoMap) -> Result<Self>

Builds a MIDI clock in the ClockDomain::MidiTick domain.

Returns an error when tpq (ticks per quarter note) is zero.

pub fn id(&self) -> &Symbol

Returns the clock’s identifying symbol.

pub fn domain(&self) -> ClockDomain

Returns the clock’s domain.

pub fn chart(&self) -> &ClockChart

Returns the clock’s timing chart.

pub fn index_for_instant(&self, instant: Instant) -> Result<IndexConversion>

Converts instant to this clock’s index, reporting whether the result is exact via the returned IndexConversion.

Returns an error when the conversion arithmetic overflows or the index does not fit in a u64.

pub fn instant_for_index(&self, index: ClockIndex) -> Result<Instant>

Converts a clock index back to its Instant.

Returns an error when the conversion arithmetic overflows.

pub fn tick_for_index(&self, cx: &mut Cx, index: ClockIndex) -> Result<Tick>

Interns index as datum content and returns the kernel Tick that carries it on this clock.

The clock index is stored as a datum node referenced by content, so kernel events keep carrying only Tick values. Returns an error when interning into the datum store fails.

pub fn index_expr(&self, index: ClockIndex) -> Expr

Builds the codec Expr extension form encoding index on this clock.

Trait Implementations

impl Clone for Clock

fn clone(&self) -> Clock

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Clock

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

Formats the value using the given formatter.

impl Eq for Clock

impl PartialEq for Clock

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