Struct SignatureParam 

#[non_exhaustive]
pub struct SignatureParam {
    pub name: String,
    pub param_type: Option<String>,
    pub domain: Option<String>,
    pub default: Option<String>,
    pub description: Option<Description>,
    pub content: Option<ParamContent>,
    pub display_name: Option<String>,
}

One parameter of a Signature.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

name: String

The semantic parameter name, or the catalog parameter name.

param_type: Option<String>

The source-backed semantic type, when declared.

domain: Option<String>

The canonical enum domain expected at this position, when declared.

default: Option<String>

The declared default applied when the argument is omitted. None marks a parameter with no declared default; a declared default before another required position does not make this position omittable (see Signature::required_params).

description: Option<Description>

The parameter’s description in the requested locale, or the primary locale’s text marked as a fallback when the requested locale has none. None when no description is recorded for the position.

content: Option<ParamContent>

The rule-content-v1 facts for this parameter when the surface signature and the content layout differ — the folded variable-target call this parameter contributes to, and the modify-operator call ids it accepts. None means the parameter maps one-to-one to a plain content argument.

display_name: Option<String>

The localized parameter display name the Workshop editor shows for this position in the requested locale, when the catalog records one. This is an editor-facing label only: it is separate from name (the semantic parameter name), from the parse spellings in paramAliases, and from default (the value applied when the argument is omitted), and it never carries an editor initial value. None marks a position whose name is on the catalog’s explicit paramDisplayNameGaps list.

Trait Implementations

impl Clone for SignatureParam

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 SignatureParam

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

Formats the value using the given formatter.

impl PartialEq for SignatureParam

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for SignatureParam