Skip to main content

Vst3PluginDescriptor

Struct Vst3PluginDescriptor 

Source
pub struct Vst3PluginDescriptor {
    pub class_id: String,
    pub name: String,
    pub vendor: String,
    pub version: String,
    pub buses: Vec<Vst3Bus>,
    pub parameters: Vec<Vst3ParamInfo>,
}
Expand description

A VST3-shaped plugin descriptor.

Collects the class identity, bus layout, and parameter set of a VST3 export; to_plugin_descriptor lowers it into the shared plugin-core PluginDescriptor consumed by the host.

Fields§

§class_id: String

The VST3 class id identifying the plugin.

§name: String

The plugin display name.

§vendor: String

The vendor name (defaults to sim).

§version: String

The plugin version (defaults to this crate’s package version).

§buses: Vec<Vst3Bus>

The declared input and output buses.

§parameters: Vec<Vst3ParamInfo>

The declared parameters.

Implementations§

Source§

impl Vst3PluginDescriptor

Source

pub fn new(class_id: impl Into<String>, name: impl Into<String>) -> Result<Self>

Builds an empty descriptor with the given class_id and name.

Validates that both are non-empty, sets vendor to sim and version to this crate’s package version, and starts with no buses or parameters.

Source

pub fn with_bus(self, bus: Vst3Bus) -> Self

Appends bus to the descriptor and returns it, for builder chaining.

Source

pub fn with_parameter(self, parameter: Vst3ParamInfo) -> Self

Appends parameter to the descriptor and returns it, for builder chaining.

Source

pub fn port_decls(&self) -> Vec<PortDecl>

Lowers every declared bus into a graph PortDecl.

Source

pub fn to_plugin_descriptor(&self) -> Result<PluginDescriptor>

Lowers this descriptor into a plugin-core PluginDescriptor.

Builds a Vst3-format PluginId from the class id and populates the resulting descriptor’s ports and parameters from this descriptor’s buses and parameter set. Returns an error if any conversion fails.

Trait Implementations§

Source§

impl Clone for Vst3PluginDescriptor

Source§

fn clone(&self) -> Vst3PluginDescriptor

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 Vst3PluginDescriptor

Source§

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

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

impl PartialEq for Vst3PluginDescriptor

Source§

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

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.