Skip to main content

TransportProfile

Struct TransportProfile 

Source
pub struct TransportProfile { /* private fields */ }
Expand description

The capability and latency contract a transport offers for a stream.

A profile pairs a name with a LatencyClass and a set of StreamCapability values, validated for mutual consistency at construction. The named constructors provide the standard fabric presets; fields are private and read through the accessor methods.

Implementations§

Source§

impl TransportProfile

Source

pub fn new( name: Symbol, latency_class: LatencyClass, capabilities: Vec<StreamCapability>, ) -> Result<Self>

Builds a profile from a name, latency class, and capability set.

Rejects inconsistent combinations – for example Exact together with Lossy, or Realtime under a non-real-time latency class – returning an error rather than a profile.

Source

pub fn memory_local() -> Self

Preset profile for in-process, in-memory streaming: block-local latency with exact, deterministic, bounded, replayable delivery.

Source

pub fn realtime_local_audio() -> Self

Preset profile for local real-time audio: sample-exact latency with exact, real-time, bounded delivery.

Source

pub fn buffered_pcm_preview() -> Self

Preset profile for buffered PCM preview: buffered-preview latency with bounded, preview, lossy delivery.

Source

pub fn remote_stream_fabric() -> Self

Preset profile for the remote stream fabric: remote-collaboration latency with remote, bounded, replayable, resumable delivery.

Source

pub fn lan_midi_control() -> Self

Preset profile for LAN MIDI control: interactive latency with remote, bounded, replayable delivery.

Source

pub fn lan_buffered_audio_preview() -> Self

Preset profile for LAN buffered audio preview: buffered-preview latency with remote, bounded, preview, lossy delivery.

Source

pub fn lan_render_return() -> Self

Preset profile for LAN render return: offline-render latency with remote, bounded, deterministic, replayable, resumable delivery.

Source

pub fn name(&self) -> &Symbol

Returns the profile’s name symbol.

Source

pub fn latency_class(&self) -> LatencyClass

Returns the latency class this profile promises.

Source

pub fn capabilities(&self) -> &[StreamCapability]

Returns the capabilities this profile grants.

Source

pub fn has_capability(&self, capability: StreamCapability) -> bool

Returns whether this profile grants capability.

Source

pub fn to_expr(&self) -> Expr

Encodes this profile into its Expr map wire form.

Round-trips back through TransportProfile::from_expr.

Source

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

Decodes a profile from its Expr map wire form.

Requires exactly the name, latency-class, and capabilities fields, and re-applies the capability/latency consistency checks via TransportProfile::new.

Trait Implementations§

Source§

impl Clone for TransportProfile

Source§

fn clone(&self) -> TransportProfile

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for TransportProfile

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for TransportProfile

Source§

impl PartialEq for TransportProfile

Source§

fn eq(&self, other: &TransportProfile) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for TransportProfile

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.