Struct ParamSpec 

pub struct ParamSpec {
    pub name: &'static str,
    pub kind: ParamKind,
    pub default: Option<&'static str>,
    pub help: &'static str,
    pub choices: &'static [&'static str],
    pub repeatable: bool,
    pub required: bool,
    pub short: Option<char>,
    pub range: Option<&'static str>,
    pub advanced: bool,
}

Definition of one parameter.

Fields

name: &'static str

kebab-case name; the CLI flag is --<name>, pipeline keys use underscores.

kind: ParamKind

default: Option<&'static str>

help: &'static str

choices: &'static [&'static str]

repeatable: bool

required: bool

short: Option<char>

range: Option<&'static str>

Allowed numeric range for documentation, e.g. “8..64”.

advanced: bool

Hidden from the compact agent catalog (still documented in full reference).

Implementations

impl ParamSpec

pub fn default(self, d: &'static str) -> Self

pub fn help(self, h: &'static str) -> Self

pub fn choices(self, c: &'static [&'static str]) -> Self

pub fn repeatable(self) -> Self

pub fn required(self) -> Self

pub fn short(self, c: char) -> Self

pub fn range(self, r: &'static str) -> Self

pub fn advanced(self) -> Self

pub fn key(&self) -> String

Pipeline/JSON key (retune-speed → retune_speed).

Trait Implementations

impl Clone for ParamSpec

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 ParamSpec

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

Formats the value using the given formatter.

impl Serialize for ParamSpec

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

where __S: Serializer,

Serialize this value into the given Serde serializer.