Struct StreamClockDescriptor 

pub struct StreamClockDescriptor { /* private fields */ }

Citizen wrapper that carries a Clock as a self-describing stream/Clock value.

The descriptor stores the clock in its encoded Expr form so it can move across codec surfaces and the kernel object system, while still decoding back to a Clock for clock math.

Examples

use sim_kernel::Symbol;
use sim_lib_stream_clock::StreamClockDescriptor;

let descriptor = StreamClockDescriptor::frame(Symbol::new("audio"), 48_000)?;
let clock = descriptor.clock()?;
assert_eq!(clock.id(), &Symbol::new("audio"));

Implementations

impl StreamClockDescriptor

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

Builds a descriptor for a frame clock with the given id and rate.

Returns an error when frames_per_second is zero.

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

Builds a descriptor for a MIDI clock with the given id, resolution, and tempo map.

Returns an error when tpq is zero.

pub fn from_clock(clock: &Clock) -> Self

Builds a descriptor by encoding an existing Clock.

pub fn from_expr(expr: Expr) -> Result<Self>

Builds a descriptor from an already-encoded clock Expr.

Returns an error when expr is not a valid stream clock encoding.

pub fn clock(&self) -> Result<Clock>

Decodes the wrapped Clock.

Returns an error when the stored encoding is invalid.

pub fn as_expr(&self) -> &Expr

Returns the wrapped clock in its encoded Expr form.

Trait Implementations

impl Citizen for StreamClockDescriptor

fn citizen_symbol() -> Symbol

The citizen’s namespace/name class symbol.

fn citizen_version() -> u32

The citizen’s encoding version.

fn citizen_arity() -> usize

Number of constructor fields (excluding the version argument).

fn citizen_fields() -> &'static [&'static str]

The citizen’s field names, in constructor order.

impl CitizenRuntime for StreamClockDescriptor

fn construct_from_values(cx: &mut Cx, args: Vec<Value>) -> Result<Self>

Builds the citizen from decoded constructor argument values.

fn example() -> Self

Returns the canonical example value used as a conformance fixture.

impl Clone for StreamClockDescriptor

fn clone(&self) -> StreamClockDescriptor

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StreamClockDescriptor

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

Formats the value using the given formatter.

impl Default for StreamClockDescriptor

fn default() -> Self

Returns the “default value” for a type.

impl Object for StreamClockDescriptor

fn display(&self, cx: &mut Cx) -> Result<String>

Render the object as a human-readable display string.

fn as_any(&self) -> &dyn Any

Expose the object for Rust downcasting.

fn header(&self) -> &ObjectHeader

Identity and trust header for the object; defaults to the shared anonymous header.

fn op(&self, _key: &OpKey) -> Option<&dyn Op>

Resolve the operation registered under key, if any.

fn claims( &self, _cx: &mut Cx, _pattern: &ClaimPattern, _sink: &mut dyn ClaimSink, ) -> Result<(), Error>

Emit the object’s claims matching pattern into sink.

fn snapshot(&self, _cx: &mut Cx) -> Result<Option<Datum>, Error>

Optional content-addressable snapshot of the object’s state.

impl ObjectCompat for StreamClockDescriptor

fn class(&self, cx: &mut Cx) -> Result<ClassRef>

Class object this value belongs to; defaults to nil.

fn as_expr(&self, cx: &mut Cx) -> Result<Expr>

Expression form of the object; defaults to an opaque extension node.

fn as_object_encoder(&self) -> Option<&dyn ObjectEncode>

Object-encoder view, if the object encodes other objects.

fn as_callable(&self) -> Option<&dyn Callable>

Callable view, if the object can be invoked.

fn as_class(&self) -> Option<&dyn Class>

Class view, if the object is a class.

fn as_shape(&self) -> Option<&dyn Shape>

Shape view, if the object is a shape.

fn as_read_constructor(&self) -> Option<&dyn ReadConstructor>

Read-constructor view, if the object decodes data forms.

fn as_number_domain(&self) -> Option<&(dyn NumberDomain + 'static)>

Number-domain view, if the object is a number domain.

fn as_number_value(&self) -> Option<&dyn NumberValue>

Number-value view, if the object is a domain number.

fn as_eval_fabric(&self) -> Option<&dyn EvalFabric>

Eval-fabric view, if the object is a distributed eval surface.

fn as_stream(&self) -> Option<&dyn Stream>

Stream view, if the object is a stream.

fn as_sequence(&self) -> Option<&dyn Sequence>

Sequence view, if the object is a sequence.

fn as_thunk(&self) -> Option<&dyn Thunk>

Thunk view, if the object is a deferred computation.

fn as_list(&self) -> Option<&(dyn ListValue + 'static)>

List view, if the object is a list value.

fn as_table_impl(&self) -> Option<&(dyn Table + 'static)>

Table-implementation view, if the object is a table.

fn as_dir(&self) -> Option<&(dyn Dir + 'static)>

Directory view, if the object is a directory.

fn truth(&self, _cx: &mut Cx) -> Result<bool, Error>

Truthiness of the object; defaults to true.

fn publish_shape_satisfaction_claims( &self, _cx: &mut Cx, _shape: &Ref, ) -> Result<bool, Error>

Publish claims asserting that the object satisfies shape; returns whether any were published.

fn as_table(&self, cx: &mut Cx) -> Result<Value, Error>

Project the object into a table value; the default exposes its display.

impl ObjectEncode for StreamClockDescriptor

fn object_encoding(&self, _cx: &mut Cx) -> Result<ObjectEncoding>

Returns the ObjectEncoding this object should be rendered as.

impl PartialEq for StreamClockDescriptor

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