Skip to main content

PluginMetadata

Struct PluginMetadata 

Source
pub struct PluginMetadata {
    pub name: String,
    pub version: String,
    pub description: String,
    pub author: Option<String>,
    pub abi_version: u32,
    pub license: Option<String>,
}
Expand description

Human-readable metadata for an audio plugin.

A plugin exposes this — via an extern "C" accessor in the full loader — so the host can log plugin identity without interpreting plugin internals. The abi_version field records which host ABI the plugin was built against (see crate::abi).

Fields§

§name: String

Short human-readable name of the plugin (e.g. "reverb-plate").

§version: String

Plugin version string (typically semver, e.g. "0.3.1"); free-form.

§description: String

One-line description of what the plugin does.

§author: Option<String>

Optional author / vendor string.

§abi_version: u32

Encoded ABI version this plugin was built against (see crate::abi).

§license: Option<String>

Optional SPDX licence identifier (e.g. "MIT").

Implementations§

Source§

impl PluginMetadata

Source

pub fn new( name: impl Into<String>, version: impl Into<String>, description: impl Into<String>, abi_version: u32, ) -> Self

Construct a PluginMetadata with the required fields, leaving author and license as None.

Source

pub fn with_author(self, author: impl Into<String>) -> Self

Builder: set the author field.

Source

pub fn with_license(self, license: impl Into<String>) -> Self

Builder: set the license field.

Trait Implementations§

Source§

impl Clone for PluginMetadata

Source§

fn clone(&self) -> PluginMetadata

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 PluginMetadata

Source§

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

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

impl Eq for PluginMetadata

Source§

impl PartialEq for PluginMetadata

Source§

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

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.