Struct Config 

pub struct Config {
    pub name: &'static str,
    pub category: Category,
    pub vendor: &'static str,
    pub url: &'static str,
    pub email: &'static str,
    pub version: &'static str,
    pub has_editor: bool,
    pub subcategories: &'static [Subcategory],
}

Format-agnostic plugin configuration.

Contains metadata shared across all plugin formats. Format-specific configurations (like VST3 UIDs or AU FourCC codes) are defined separately.

Fields

name: &'static str

Plugin name displayed in the DAW.

category: Category

Plugin category (effect, instrument, etc.)

vendor: &'static str

Vendor/company name.

url: &'static str

Vendor URL.

email: &'static str

Vendor email.

version: &'static str

Plugin version string.

has_editor: bool

Whether this plugin has an editor/GUI.

subcategories: &'static [Subcategory]

Plugin subcategories for more specific classification.

Implementations

impl Config

pub const fn new(name: &'static str, category: Category) -> Self

Create a new plugin configuration with default values.

Example

pub static CONFIG: Config = Config::new("My Plugin", Category::Effect)
    .with_vendor("My Company")
    .with_version(env!("CARGO_PKG_VERSION"));

pub const fn with_vendor(self, vendor: &'static str) -> Self

Set the vendor name.

pub const fn with_url(self, url: &'static str) -> Self

Set the vendor URL.

pub const fn with_email(self, email: &'static str) -> Self

Set the vendor email.

pub const fn with_version(self, version: &'static str) -> Self

Set the version string.

pub const fn with_editor(self) -> Self

Enable the editor/GUI.

pub const fn with_subcategories( self, subcategories: &'static [Subcategory], ) -> Self

Set the plugin subcategories.

Subcategories provide more specific classification beyond the main category. They are used for VST3 subcategory strings and AU tags.

Example

pub static CONFIG: Config = Config::new("My Compressor", Category::Effect)
    .with_subcategories(&[Subcategory::Dynamics]);

pub fn vst3_subcategories(&self) -> String

Build the VST3 subcategories string.

Combines the main category with subcategories using pipe separators. For example: Category::Effect with [Subcategory::Dynamics] becomes "Fx|Dynamics".

Example

let config = Config::new("My Plugin", Category::Effect)
    .with_subcategories(&[Subcategory::Dynamics, Subcategory::Eq]);
assert_eq!(config.vst3_subcategories(), "Fx|Dynamics|EQ");

pub fn au_tags(&self) -> Vec<&'static str>

Get AU tags derived from subcategories.

Returns tags for subcategories that have AU equivalents. Subcategories without AU mappings are skipped.

Example

let config = Config::new("My Plugin", Category::Effect)
    .with_subcategories(&[Subcategory::Dynamics, Subcategory::Eq]);
assert_eq!(config.au_tags(), vec!["Dynamics", "EQ"]);

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Config

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

Formats the value using the given formatter.