Skip to main content

PluginRef

Struct PluginRef 

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

A plugin class to load: its identity and where it is installed. VST3 and CLAP classes live in a bundle; Audio Units have none, the system registry finds them. Build it with the format’s constructor, or take it from the scanner’s catalog.

Implementations§

Source§

impl PluginRef

Source

pub fn vst3( bundle: impl Into<PathBuf>, class_id: impl Into<String>, ) -> PluginRef

The VST3 class class_id in the .vst3 bundle (or, on Windows, single-file module) at bundle.

Source

pub fn clap( bundle: impl Into<PathBuf>, class_id: impl Into<String>, ) -> PluginRef

The CLAP plugin class_id in the .clap bundle at bundle.

Source

pub fn audio_unit(class_id: impl Into<String>) -> PluginRef

The registered Audio Unit class_id.

Source

pub fn id(&self) -> &PluginId

The class’s identity.

Source

pub fn bundle(&self) -> Option<&Path>

The bundle that contains a VST3 or CLAP class; None for an Audio Unit.

Trait Implementations§

Source§

impl Clone for PluginRef

Source§

fn clone(&self) -> Self

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 PluginRef

Source§

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

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

impl Eq for PluginRef

Source§

impl PartialEq for PluginRef

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for PluginRef

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 = !

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

fn try_from(value: U) -> Result<T, !>

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.