Struct ParameterDef 

pub struct ParameterDef {

    pub name: String,
    pub label: String,
    pub description: String,
    pub param_type: ParameterType,
    pub default: Option<Value>,
    pub constraints: Option<Constraints>,
    pub placeholder: Option<String>,
    pub visible_when: Option<ParamCondition>,
    pub required_when: Option<ParamCondition>,
    pub surfaceable: bool,
    pub run_option: bool,
    pub group: Option<String>,
    pub suffix: Option<String>,
    pub control: Option<String>,
    pub accept: Option<Vec<String>>,
    pub presets: Option<Vec<PresetEntry>>,
    pub inverted: Option<bool>,
}

A complete definition of one parameter a node accepts. Provides everything the engine (validation) and UI (control rendering) need.

Fields

name: String

label: String

description: String

param_type: ParameterType

Value type — determines what UI control to render.

default: Option<Value>

constraints: Option<Constraints>

placeholder: Option<String>

visible_when: Option<ParamCondition>

required_when: Option<ParamCondition>

surfaceable: bool

Whether this param can be surfaced in container config panels.

run_option: bool

Whether someone running a recipe sets this param: the run screen shows it when the recipe declares no fields. False for params that are the program itself (a shell command and its args), which only the author sets; authoring surfaces go by surfaceable. Native-only: no browser node needs it, so it stays out of the catalog.

group: Option<String>

suffix: Option<String>

control: Option<String>

Override control identifier (e.g., "slider", "select", "file").

accept: Option<Vec<String>>

presets: Option<Vec<PresetEntry>>

inverted: Option<bool>

Flip the semantic of a boolean control.

Trait Implementations

impl Clone for ParameterDef

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 ParameterDef

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

Formats the value using the given formatter.

impl Default for ParameterDef

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for ParameterDef

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for ParameterDef

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 ParameterDef