Struct ParamInfo 

pub struct ParamInfo {
    pub name: &'static str,
    pub default: ParamDefault,
    pub unit: &'static str,
    pub choices: &'static [&'static str],
    pub gt: Option<f64>,
    pub ge: Option<f64>,
    pub le: Option<f64>,
    pub lt: Option<f64>,
    pub doc: &'static str,
    pub schema: Value,
    pub variants: Vec<(&'static str, Vec<ParamInfo>)>,
    pub fields: Vec<ParamInfo>,
}

One parameter of a block.

Fields

name: &'static str

Name.

default: ParamDefault

Default.

unit: &'static str

Unit (dB, Hz, ps/nm/km…; empty for a number without unit or a non-number).

choices: &'static [&'static str]

The accepted values of a string (empty: any value of the type).

gt: Option<f64>

Exclusive lower bound of a number.

ge: Option<f64>

Inclusive lower bound of a number.

le: Option<f64>

Inclusive upper bound of a number.

lt: Option<f64>

Exclusive upper bound of a number.

doc: &'static str

Meaning.

schema: Value

The JSON Schema of the type of the value ({"type": "number"}…).

variants: Vec<(&'static str, Vec<ParamInfo>)>

The mappings the value may be, by their type, each with its parameters (the codes of fec_encode, see ParamType::variants); empty for any other value.

fields: Vec<ParamInfo>

The keys of a value that is a mapping of parameters (Mapping, NameOr, see ParamType::fields); empty for any other value.

Implementations

impl ParamInfo

pub fn describe(&self, indent: usize) -> String

The parameter as one line of text (name, default, meaning, unit, accepted values, bounds), then one line per key of its mapping and per parameter of every variant of its value, indented.

pub fn default_text(&self) -> String

The default as text: required, the value, or what an absent value means.

pub fn json_schema(&self) -> Json

The JSON Schema of the parameter: its type, unit, accepted values, bounds, default and meaning (a string $name of a grid variable is accepted too).

Trait Implementations

impl Clone for ParamInfo

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 ParamInfo

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

Formats the value using the given formatter.