Struct ArgSpec 

pub struct ArgSpec {

    pub id: String,
    pub long: Option<String>,
    pub short: Option<char>,
    pub short_aliases: Vec<char>,
    pub aliases: Vec<String>,
    pub value_name: Option<String>,
    pub value: ValueHint,
    pub help: String,
    pub long_help: Option<String>,
    pub default: Option<String>,
    pub env: Option<String>,
    pub config_key: Option<String>,
    pub required: bool,
    pub multiple: bool,
    pub hidden: bool,
    pub heading: Option<String>,
    pub positional: bool,
    pub global: bool,
}

An option, flag or positional argument.

use rich_ext::cli_doc::{ArgSpec, ValueHint};

let color = ArgSpec::option("color")
    .value_name("WHEN")
    .choices(["auto", "always", "never"])
    .default_value("auto")
    .env("RICH_COLOR")
    .help("When to use colour");
assert_eq!(color.names(), "--color <WHEN>");
assert!(matches!(color.value, ValueHint::Choices(ref c) if c.len() == 3));

Fields

id: String

A stable identifier; also the default value name.

long: Option<String>

The long name, without dashes.

short: Option<char>

short_aliases: Vec<char>

Extra short names, without the dash (-J beside -j).

aliases: Vec<String>

Extra long names, without dashes.

value_name: Option<String>

The metavar shown as <VALUE>. None makes the argument a flag.

value: ValueHint

help: String

long_help: Option<String>

Help for --help (long) output; help is used when absent.

default: Option<String>

env: Option<String>

The environment variable that sets this argument.

config_key: Option<String>

The config file key that sets this argument.

required: bool

multiple: bool

Whether the argument may be given more than once (or takes a list).

hidden: bool

Hidden arguments are left out of help, docs and completions.

heading: Option<String>

The help group title; None means “Options” (or “Arguments” for a positional).

positional: bool

global: bool

A global option applies to every subcommand below the command that declares it, so completions offer it there too (clap’s Arg::global).

Implementations

impl ArgSpec

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

A bare argument with only an id; set the rest with the builders.

pub fn flag(long: impl Into<String>) -> Self

A --long flag that takes no value.

pub fn option(long: impl Into<String>) -> Self

A --long <LONG> option taking any value.

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

A positional argument shown as [NAME], or <NAME> when required.

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

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

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

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

Another short name, listed after short.

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

Set the metavar; this also makes a flag take a value.

pub fn value(self, hint: ValueHint) -> Self

Set the value hint; a non-None hint makes a flag take a value.

pub fn choices<C: Into<Choice>>( self, choices: impl IntoIterator<Item = C>, ) -> Self

Restrict the value to choices.

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

Add one allowed value with help.

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

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

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

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

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

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

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

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

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

Offer this option in every subcommand below its command, too.

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

pub fn takes_value(&self) -> bool

Whether the argument takes a value.

pub fn choice_list(&self) -> &[Choice]

The allowed values, if restricted.

pub fn group(&self) -> &str

The help group this argument belongs to.

pub fn metavar(&self) -> Option<String>

The metavar as displayed: <NAME> (plus ... when multiple), or the name unchanged when it already carries brackets.

pub fn switches(&self) -> Vec<String>

Every command-line spelling: -s and its short aliases, --long, then --aliases.

pub fn names(&self) -> String

The names as help shows them: -w, --width <SIZE>; a positional shows only its metavar.

pub fn primary(&self) -> String

The primary switch: --long, else -s, else the id.

Trait Implementations

impl Clone for ArgSpec

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 ArgSpec

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

Formats the value using the given formatter.

impl Default for ArgSpec

fn default() -> Self

Returns the “default value” for a type.

impl Eq for ArgSpec

impl PartialEq for ArgSpec

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for ArgSpec