Struct OptionDescriptor 

pub struct OptionDescriptor {
    pub key: String,
    pub label: String,
    pub help: String,
    pub kind: OptionKind,
    pub unit: Option<String>,
}

Description of one option a block accepts (spec §3.2.1).

Resolved by an engine against a model, because permissible values and correct defaults are often properties of the model in hand — which constituents exist, and what unit system the file declares. A consumer displays what it is given and computes nothing.

Fields

key: String

Field name in the block’s options object.

label: String

Human-facing control label.

help: String

One or two sentences explaining what the option does.

kind: OptionKind

Value shape and bounds.

unit: Option<String>

Display unit text, or None. Display only — never a unit system.

Trait Implementations

impl Clone for OptionDescriptor

fn clone(&self) -> OptionDescriptor

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OptionDescriptor

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for OptionDescriptor

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for OptionDescriptor

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for OptionDescriptor

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for OptionDescriptor