Enum ClockDomain 

pub enum ClockDomain {
    Sample,
    Block,
    Control,
    MidiTick,
    Wall,
    Transport,
    ServerFrame,
    BrowserFrame,
    TraceStep,
    Job,
}

Clock a stream is timed against.

Each variant names one timeline a packet can ride; the kernel defines the clock-domain contract as Symbols, and this enum is the concrete set this fabric understands. ClockDomain::symbol maps a variant to its kernel symbol and ClockDomain::from_symbol parses it back, accepting the bare label, the clock/<label> form, and the fully qualified stream/clock-domain/<label> form.

Examples

use sim_lib_stream_core::ClockDomain;

let domain = ClockDomain::Sample;
assert_eq!(domain.wire_label(), "sample");
let parsed = ClockDomain::from_symbol(&domain.symbol()).unwrap();
assert_eq!(parsed, domain);

Variants

Sample

Per-sample audio timeline (the finest audio clock).

Block

Per-block processing timeline (one tick per audio block).

Control

Control-rate timeline for parameter and modulation updates.

MidiTick

MIDI tick timeline (musical clock pulses).

Wall

Wall-clock (real-world) time.

Transport

Transport timeline (musical position: bars/beats under play control).

ServerFrame

Server-side frame timeline.

BrowserFrame

Browser-side frame timeline (client render cadence).

TraceStep

Trace-step timeline for stepped/replayed execution.

Job

Job timeline keyed to background job progress.

Implementations

impl ClockDomain

pub fn wire_label(self) -> &'static str

Returns the stable wire label for this domain (for example "sample").

pub fn symbol(self) -> Symbol

Returns the kernel Symbol for this domain, namespaced under stream/clock-domain.

pub fn from_symbol(symbol: &Symbol) -> Result<Self>

Parses a ClockDomain from a kernel Symbol.

Accepts the bare label, the legacy clock/<label> form, and the fully qualified stream/clock-domain/<label> form. Returns an error for any unrecognized clock domain.

pub fn for_stream_clock(symbol: &Symbol) -> Self

Resolves the clock domain for a stream’s declared clock symbol, falling back to ClockDomain::ServerFrame when the symbol is unrecognized.

Trait Implementations

impl Clone for ClockDomain

fn clone(&self) -> ClockDomain

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for ClockDomain

impl Debug for ClockDomain

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

Formats the value using the given formatter.

impl Eq for ClockDomain

impl PartialEq for ClockDomain

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