Struct ParameterConfig 

pub struct ParameterConfig {
    pub name: String,
    pub nargs: Nargs,
    pub multiple: bool,
    pub is_eager: bool,
    pub expose_value: bool,
    pub required: bool,
    pub envvar: Option<Vec<String>>,
    pub help: Option<String>,
    pub hidden: bool,
    pub metavar: Option<String>,
    pub deprecated: Option<DeprecationInfo>,
    pub callback: Option<ParameterCallback>,
}

Common configuration for all parameter types.

This struct holds the shared settings between Options and Arguments. It uses a builder pattern for convenient construction.

Fields

name: String

The parameter name.

nargs: Nargs

Number of arguments consumed.

multiple: bool

Whether the parameter can be specified multiple times.

is_eager: bool

Whether this parameter should be processed before others.

expose_value: bool

Whether this parameter’s value is exposed in ctx.params.

required: bool

Whether this parameter is required.

envvar: Option<Vec<String>>

Environment variable name(s) for this parameter.

help: Option<String>

Help text for this parameter.

hidden: bool

Whether this parameter is hidden from help.

metavar: Option<String>

Custom metavar for help text.

deprecated: Option<DeprecationInfo>

Whether this parameter is deprecated.

callback: Option<ParameterCallback>

Optional callback invoked after conversion.

Implementations

impl ParameterConfig

pub fn new(name: impl Into<String>) -> Self

Create a new parameter configuration with the given name.

pub fn nargs(self, nargs: Nargs) -> Self

Set the number of arguments consumed.

pub fn multiple(self, multiple: bool) -> Self

Set whether the parameter can be specified multiple times.

pub fn eager(self, eager: bool) -> Self

Set whether this parameter should be processed before others.

pub fn expose_value(self, expose: bool) -> Self

Set whether this parameter’s value is exposed in ctx.params.

pub fn required(self, required: bool) -> Self

Set whether this parameter is required.

pub fn envvar(self, var: impl Into<String>) -> Self

Set a single environment variable for this parameter.

pub fn envvars(self, vars: impl IntoIterator<Item = impl Into<String>>) -> Self

Set multiple environment variables for this parameter.

pub fn help(self, help: impl Into<String>) -> Self

Set the help text.

pub fn hidden(self, hidden: bool) -> Self

Set whether this parameter is hidden from help.

pub fn metavar(self, metavar: impl Into<String>) -> Self

Set a custom metavar for help text.

pub fn callback(self, callback: ParameterCallback) -> Self

Set a callback invoked after conversion.

pub fn deprecated(self, deprecated: bool) -> Self

Mark this parameter as deprecated.

pub fn deprecated_with_message(self, message: impl Into<String>) -> Self

Mark this parameter as deprecated with a custom message.

pub fn validate(&self) -> Result<(), ClickError>

Validate the configuration.

Returns an error if the configuration is invalid.

Trait Implementations

impl Clone for ParameterConfig

fn clone(&self) -> ParameterConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ParameterConfig

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

Formats the value using the given formatter.

impl Default for ParameterConfig

fn default() -> Self

Returns the “default value” for a type.