Struct ParamSpec 

pub struct ParamSpec {

    pub key: String,
    pub kind: ParamKind,
    pub stored_min: f64,
    pub stored_max: f64,
    pub default: f64,
    pub law: Option<UnitLaw>,
    pub label: String,
    pub choices: Vec<String>,
    pub provenance: Provenance,
    pub evidence: String,
    pub first_build: Option<Build>,
    pub verified_on: Option<Build>,
    pub tuning_note: Option<String>,
    pub legacy: bool,
}

One control of a synth.

Fields

key: String

The key in the preset file. Unique within a registry.

kind: ParamKind

What the stored value is.

stored_min: f64

The smallest stored value.

stored_max: f64

The largest stored value.

default: f64

The stored value of a new patch, inside the range.

law: Option<UnitLaw>

The physical unit and its law, or None when no unit is claimed.

label: String

The on-screen name of the control.

choices: Vec<String>

Menu labels of a ParamKind::Choice: choices[i] names the stored value stored_min + i.

provenance: Provenance

Where the law comes from.

evidence: String

The source file, document or probe behind the entry.

first_build: Option<Build>

The first build that has the control.

verified_on: Option<Build>

The build where a load check or a probe confirmed the key and its default. A confirmed range or law is named in evidence.

tuning_note: Option<String>

How to tune an interim control by ear and what to hear.

legacy: bool

The control is in the table, but no module creates it. Readers accept it and writers refuse it.

Implementations

impl ParamSpec

pub fn unit(&self) -> Option<UnitKind>

The physical unit, if the entry claims one.

pub fn range_text(&self) -> String

The stored range as text, such as 8.0 to 136.0.

pub fn accepts(&self, stored: f64) -> bool

Whether a stored value lies inside the range and suits the kind.

pub fn accepts_saved(&self, stored: f64) -> bool

Whether a saved preset may hold stored: Self::accepts, with each bound widened to its 32-bit float form, which a synth that keeps controls as f32 saves.

pub fn physical(&self, stored: f64) -> Result<Physical, ParamError>

The physical value of a stored value.

Errors

A ParamError naming the key when the entry has no unit, the stored value is outside the range or not whole where it must be, or the law or the unit type rejects it.

pub fn stored(&self, value: &Physical) -> Result<f64, ParamError>

The stored value of a physical value.

Errors

A ParamError naming the key when the unit type differs from the entry’s, the law rejects the value, or the result is outside the stored range or not whole where it must be.

Trait Implementations

impl Clone for ParamSpec

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ParamSpec

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

Formats the value using the given formatter.

impl PartialEq for ParamSpec

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ParamSpec