Struct RateContract 

pub struct RateContract { /* private fields */ }

Timing agreement a stream port advertises and must share to connect.

Pairs a ClockDomain with a LatencyClass and an optional nominal sample rate in hertz. Two ports may be wired together only when their contracts are compatible (see is_compatible_with).

Implementations

impl RateContract

pub fn new( clock_domain: ClockDomain, latency_class: LatencyClass, nominal_rate_hz: Option<u32>, ) -> Self

Builds a contract from an explicit clock domain, latency class, and optional nominal rate.

pub fn sample_exact(nominal_rate_hz: Option<u32>) -> Self

Contract for sample-exact audio: sample clock domain, sample-exact latency, and the given nominal rate.

pub fn block_local() -> Self

Contract for block-local processing: block clock domain and block-local latency, with no fixed nominal rate.

pub fn control() -> Self

Contract for interactive control traffic: control clock domain and interactive latency.

pub fn midi_tick() -> Self

Contract for MIDI-tick traffic: MIDI-tick clock domain and interactive latency.

pub fn trace_step() -> Self

Contract for offline trace stepping: trace-step clock domain and offline-render latency.

pub fn clock_domain(self) -> ClockDomain

Returns the clock domain this contract runs in.

pub fn latency_class(self) -> LatencyClass

Returns the latency class this contract promises.

pub fn nominal_rate_hz(self) -> Option<u32>

Returns the nominal sample rate in hertz, if one is fixed.

pub fn is_compatible_with(self, other: Self) -> bool

Reports whether self and other may be connected.

Compatible means matching clock domain and latency class; nominal rates must agree only when both are fixed (an unset rate matches any rate).

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

Checks compatibility with other, returning a descriptive error when the two contracts cannot be connected.

Trait Implementations

impl Clone for RateContract

fn clone(&self) -> RateContract

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for RateContract

impl Debug for RateContract

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

Formats the value using the given formatter.

impl Eq for RateContract

impl PartialEq for RateContract

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