Struct ParamSpec 

pub struct ParamSpec {
    pub name: &'static str,
    pub slot_type: SlotType,
    pub required: bool,
    pub example: &'static str,
    pub constraint: Option<ConstConstraint>,
}

Describes one parameter in a function’s call signature.

A “slot template” — the type-level version of a Slot without a concrete value. Parameters are listed in positional order matching the DSL syntax.

Fields

name: &'static str

Parameter name (for error messages and describe output).

slot_type: SlotType

Wire or constant, and if constant, what type.

required: bool

Whether this parameter must be provided.

example: &'static str

Example value for this parameter, used for probing compile level and for documentation. Wire params use "cycle", const params use a representative value that passes validation.

constraint: Option<ConstConstraint>

Optional assembly-time validation rule (SRD 15 §“Const Constraint Metadata”). The factory enforces this before build_node so node constructors can stay infallible and branch-free at runtime. None = no constraint declared (default for wires and unconstrained constants).

Implementations

impl ParamSpec

pub const fn with_constraint(self, c: ConstConstraint) -> Self

Convenience: chainable on a literal to attach a constraint. Used by node modules that want to keep the literal compact.

Trait Implementations

impl Clone for ParamSpec

fn clone(&self) -> ParamSpec

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for ParamSpec

impl Debug for ParamSpec

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

Formats the value using the given formatter.