Struct ParamMetadata 

pub struct ParamMetadata {
    pub name: String,
    pub description: String,
    pub typ: ParamType,
    pub default: ParamValue,
    pub range: ParamRange,
    pub unit: Option<String>,
    pub choices: Option<Vec<(String, f32)>>,
}

Metadata about a parameter

Fields

name: String

Parameter name (must be a valid ParameterId)

description: String

Human-readable description

typ: ParamType

Parameter type

default: ParamValue

Default value

range: ParamRange

Value range (if applicable)

unit: Option<String>

Unit of measurement (e.g., “Hz”, “dB”, “ms”)

choices: Option<Vec<(String, f32)>>

Possible choices (for Choice parameters)

Implementations

impl ParamMetadata

pub fn new( name: impl Into<String>, typ: ParamType, default: ParamValue, ) -> ParamMetadata

Create new parameter metadata

pub fn with_description(self, description: impl Into<String>) -> ParamMetadata

Set description

pub fn with_range(self, min: f32, max: f32, step: f32) -> ParamMetadata

Set range

pub fn with_unit(self, unit: impl Into<String>) -> ParamMetadata

Set unit

pub fn with_choices(self, choices: Vec<(String, f32)>) -> ParamMetadata

Set choices

Trait Implementations

impl Clone for ParamMetadata

fn clone(&self) -> ParamMetadata

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ParamMetadata

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

Formats the value using the given formatter.

impl PartialEq for ParamMetadata

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for ParamMetadata