Struct ClickOption 

pub struct ClickOption {

    pub config: ParameterConfig,
    pub long: Vec<String>,
    pub short: Vec<String>,
    pub is_flag: bool,
    pub is_bool_flag: bool,
    pub flag_value: Option<String>,
    pub secondary_value: Option<String>,
    pub count: bool,
    pub prompt: Option<String>,
    pub confirmation_prompt: bool,
    pub hide_input: bool,
    pub show_default: bool,
    pub show_envvar: bool,
    pub default: Option<String>,
    /* private fields */
}

A named command-line parameter (e.g., –name, -n).

Options are typically optional values that can be specified with flags. They support various modes including:

• Regular value options (--name VALUE)
• Flags (--verbose)
• Boolean flags (--flag/--no-flag)
• Count mode (-v -v -v = 3)
• Prompts for interactive input

Note: Named ClickOption to avoid shadowing std::option::Option.

Fields

config: ParameterConfig

Base parameter configuration.

long: Vec<String>

Long option names (e.g., [“–name”, “–full-name”]).

short: Vec<String>

Short option names (e.g., [“-n”, “-N”]).

is_flag: bool

Whether this is a flag (no value required).

is_bool_flag: bool

Whether this is a boolean flag (–flag/–no-flag).

flag_value: Option<String>

Value when flag is present (None means true for bool flags).

secondary_value: Option<String>

Secondary value for –no-flag (None means false for bool flags).

count: bool

Count mode (-v -v -v = 3).

prompt: Option<String>

Prompt text for interactive input (None = no prompt).

confirmation_prompt: bool

Whether to ask twice (confirmation).

hide_input: bool

Hide input (for passwords).

show_default: bool

Show default value in help text.

show_envvar: bool

Show environment variable in help text.

default: Option<String>

Default value as string.

Implementations

impl ClickOption

pub fn new(names: &[&str]) -> OptionBuilder

Create a new option builder with the given names.

Names should include the dashes (e.g., “–name”, “-n”).

Panics

Panics if no valid option names are provided.

pub fn opts_string(&self) -> String

Get all option names (long and short) joined for display.

pub fn primary_opt(&self) -> &str

Get the primary option string (first long or first short).

pub fn type_converter(&self) -> &dyn AnyTypeConverter

Get the type converter for this option.

pub fn convert_any( &self, value: &str, ) -> Result<Box<dyn Any + Send + Sync>, String>

Convert a string value using this option’s type converter. Returns the converted value as a boxed Any type.

pub fn convert_multi( &self, values: &[String], ) -> Result<Box<dyn Any + Send + Sync>, String>

Convert multiple string values using this option’s type converter. Returns the converted value as a boxed Any type.

pub fn get_completions( &self, ctx: &Context, incomplete: &str, ) -> Vec<CompletionItem>

Get shell completions for this option value.

If a custom shell completion callback is set, it takes precedence over type-driven completions.

pub fn has_shell_complete_callback(&self) -> bool

Check if this option has a custom shell completion callback.

Trait Implementations

impl Clone for ClickOption

fn clone(&self) -> ClickOption

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ClickOption

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

Formats the value using the given formatter.

impl Parameter for ClickOption

fn name(&self) -> &str

The primary name of the parameter.

fn human_readable_name(&self) -> String

Human-readable name for errors and help text.

fn nargs(&self) -> Nargs

Number of arguments this parameter consumes.

fn multiple(&self) -> bool

Whether this parameter can be specified multiple times.

fn is_eager(&self) -> bool

Whether this parameter should be processed before others.

fn expose_value(&self) -> bool

Whether this parameter’s value should be exposed in ctx.params.

fn required(&self) -> bool

Whether this parameter is required.

fn envvar(&self) -> Option<&[String]>

Get environment variable name(s) for this parameter.

fn help(&self) -> Option<&str>

Get help text for this parameter.

fn hidden(&self) -> bool

Whether this parameter is hidden from help.

fn get_metavar(&self) -> Option<String>

Get the metavar for help text (e.g., “FILE”, “TEXT”).

fn get_help_record(&self) -> Option<(String, String)>

Generate help record for formatting.

fn param_type_name(&self) -> &str

Get the parameter type name (for error messages).