Skip to main content

InstrumentTopologyModule

Struct InstrumentTopologyModule 

Source
pub struct InstrumentTopologyModule {
    pub id: NodeId,
    pub kind: Symbol,
    pub inputs: Vec<InstrumentTopologyJack>,
    pub outputs: Vec<InstrumentTopologyJack>,
    pub settings: Vec<(Symbol, Expr)>,
    pub raw_view: Vec<(Symbol, Expr)>,
}
Expand description

One module in an instrument spec: a node kind with input/output jacks, settings, and an opaque raw view.

Fields§

§id: NodeId

The module’s node id.

§kind: Symbol

The module kind (becomes the node verb/class symbol).

§inputs: Vec<InstrumentTopologyJack>

Input jacks (lowered to input ports).

§outputs: Vec<InstrumentTopologyJack>

Output jacks (lowered to output ports).

§settings: Vec<(Symbol, Expr)>

Module settings, lowered to a settings node option map.

§raw_view: Vec<(Symbol, Expr)>

Opaque module state, lowered to a raw-view node option map.

Implementations§

Source§

impl InstrumentTopologyModule

Source

pub fn new(id: impl Into<NodeId>, kind: Symbol) -> Self

Starts a module with the given id and kind.

Source

pub fn with_input(self, jack: InstrumentTopologyJack) -> Self

Adds an input jack, returning the updated module.

Source

pub fn with_output(self, jack: InstrumentTopologyJack) -> Self

Adds an output jack, returning the updated module.

Source

pub fn with_setting(self, key: Symbol, value: Expr) -> Self

Adds a setting, returning the updated module.

Source

pub fn with_raw(self, key: Symbol, value: Expr) -> Self

Adds a raw-view entry, returning the updated module.

Trait Implementations§

Source§

impl Clone for InstrumentTopologyModule

Source§

fn clone(&self) -> InstrumentTopologyModule

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 InstrumentTopologyModule

Source§

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

Formats the value using the given formatter. Read more

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.