Struct OptionBuilder 

pub struct OptionBuilder { /* private fields */ }

Builder for constructing ClickOption instances.

Implementations

impl OptionBuilder

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

Create a new option builder with the given names.

Panics

Panics if the names cannot be parsed as valid option names.

pub fn dest(self, name: &str) -> Self

Override the destination parameter name used in context storage.

This allows multiple flags/options to write to the same logical value.

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

Set the help text for this option.

pub fn flag(self, value: &str) -> Self

Make this a simple flag with the given value when present.

When the flag is used, its value will be set to the provided value.

pub fn bool_flag(self) -> Self

Make this a boolean flag (–flag/–no-flag style).

The option will accept both –flag (true) and –no-flag (false).

pub fn count(self) -> Self

Enable count mode (-v -v -v = 3).

Each occurrence of the flag increments an integer counter.

pub fn required(self) -> Self

Mark this option as required.

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

Set a default value.

pub fn envvar(self, name: &str) -> Self

Set an environment variable for this option.

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

Set multiple environment variables (first found is used).

pub fn prompt(self, text: &str) -> Self

Set a prompt text for interactive input.

pub fn confirmation_prompt(self, confirm: bool) -> Self

Enable confirmation prompt (ask twice).

pub fn hide_input(self, hide: bool) -> Self

Hide input (for passwords).

pub fn multiple(self) -> Self

Allow this option to be specified multiple times.

pub fn callback<F>(self, callback: F) -> Self

where F: Fn(&Context, &dyn Parameter, Arc<dyn Any + Send + Sync>) -> Result<Arc<dyn Any + Send + Sync>, ClickError> + Send + Sync + 'static,

Set a callback invoked after conversion.

pub fn shell_complete<F>(self, callback: F) -> Self

where F: Fn(&Context, &str) -> Vec<CompletionItem> + Send + Sync + 'static,

Set a custom shell completion callback for option values.

pub fn hidden(self) -> Self

Hide this option from help output.

pub fn eager(self) -> Self

Make this an eager option (processed before others).

Eager options like –help and –version are processed first and can short-circuit command execution.

pub fn show_default(self) -> Self

Show the default value in help text.

pub fn show_envvar(self) -> Self

Show the environment variable in help text.

pub fn metavar(self, metavar: &str) -> Self

Set a custom metavar for help text.

pub fn type_<T: TypeConverter<Value = String> + Send + Sync + 'static>( self, type_: T, ) -> Self

Set the type converter for this option.

pub fn type_any<V: Send + Sync + 'static, T: TypeConverter<Value = V> + Send + Sync + 'static>( self, type_: T, ) -> Self

Set the type using any TypeConverter (storing name and metavar).

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

Set how many arguments this option consumes.

pub fn build(self) -> ClickOption

Build the ClickOption.