Skip to main content

Module option

Module option 

Source
Expand description

Option parameter for click-rs.

This module provides the ClickOption struct for named command-line parameters (e.g., --name, -n). Options differ from arguments in that they are typically optional and can have flags, boolean modes, and prompts.

§Reference

Based on Python Click’s core.py:Option class (line 2641+).

Structs§

ClickOption
A named command-line parameter (e.g., –name, -n).
OptionBuilder
Builder for constructing ClickOption instances.

Functions§

parse_option_name
Parse a single option name, returning (stripped_name, is_long).
split_option_names
Split option names into (long_options, short_options).

Type Aliases§

ShellCompleteCallback
Custom shell completion callback type for option values.