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,
}

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

Fields

name: String

The parameter’s key name in config JSON (e.g., "quality").

label: String

Human-readable label for the UI.

description: String

Description shown as tooltip or help text.

param_type: ParameterType

Value type — determines what UI control to render.

default: Option<Value>

Default value (heterogeneous type via serde_json::Value).

constraints: Option<Constraints>

Optional validation constraints (min/max range, required flag).

placeholder: Option<String>

Placeholder text for input controls.

visible_when: Option<ParamCondition>

Show this parameter only when another parameter matches a value.

required_when: Option<ParamCondition>

Require this parameter only when another parameter matches a value.

surfaceable: bool

Whether this param can be surfaced in container config panels. Defaults to true. Set false for internal wiring params.

Trait Implementations

impl Clone for ParameterDef

fn clone(&self) -> ParameterDef

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

Manual Default because surfaceable must default to true, not false.

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for ParameterDef

fn eq(&self, other: &ParameterDef) -> 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 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