Skip to main content

Lv2Port

Struct Lv2Port 

Source
pub struct Lv2Port {
    pub index: u32,
    pub symbol: String,
    pub name: String,
    pub kind: Lv2PortKind,
    pub dir: PortDir,
    pub channels: u16,
}
Expand description

One declared port of an Lv2PluginDescriptor.

Carries the LV2 port metadata and lowers to a graph PortDecl via Lv2Port::to_port_decl.

Fields§

§index: u32

The LV2 port index within its plugin.

§symbol: String

The LV2 port symbol, used as the graph port name.

§name: String

The human-readable port name.

§kind: Lv2PortKind

The LV2 port class.

§dir: PortDir

The signal direction (input or output).

§channels: u16

The number of graph lanes (channels) this port exposes.

Implementations§

Source§

impl Lv2Port

Source

pub fn new( index: u32, symbol: impl Into<String>, name: impl Into<String>, kind: Lv2PortKind, dir: PortDir, channels: u16, ) -> Result<Self>

Builds a port from its fields, validating symbol, name, and channels.

§Errors

Returns Error::Eval when symbol or name is blank, or when channels is zero.

Source

pub fn audio_input( index: u32, symbol: impl Into<String>, channels: u16, ) -> Result<Self>

Builds an audio input port named “Audio Input” with channels lanes.

§Errors

Returns Error::Eval when symbol is blank or channels is zero.

Source

pub fn audio_output( index: u32, symbol: impl Into<String>, channels: u16, ) -> Result<Self>

Builds an audio output port named “Audio Output” with channels lanes.

§Errors

Returns Error::Eval when symbol is blank or channels is zero.

Source

pub fn control_input( index: u32, symbol: impl Into<String>, name: impl Into<String>, ) -> Result<Self>

Builds a single-lane control input port with the given name.

§Errors

Returns Error::Eval when symbol or name is blank.

Source

pub fn atom_input(index: u32, symbol: impl Into<String>) -> Result<Self>

Builds a single-lane atom-sequence input port named “Events In”.

§Errors

Returns Error::Eval when symbol is blank.

Source

pub fn to_port_decl(&self) -> PortDecl

Lowers this port to a graph PortDecl.

Trait Implementations§

Source§

impl Clone for Lv2Port

Source§

fn clone(&self) -> Lv2Port

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 Lv2Port

Source§

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

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

impl Eq for Lv2Port

Source§

impl PartialEq for Lv2Port

Source§

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

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.