Struct ArgInfo 

#[non_exhaustive]
pub struct ArgInfo {

    pub id: &'static str,
    pub kind: ArgKind,
    pub short: Option<char>,
    pub long: Option<&'static str>,
    pub visible_short_aliases: &'static [char],
    pub short_aliases: &'static [char],
    pub visible_aliases: &'static [&'static str],
    pub aliases: &'static [&'static str],
    pub value_name: &'static str,
    pub help: &'static str,
    pub long_help: &'static str,
    pub possible_values: &'static [&'static str],
    pub env: Option<&'static str>,
    pub hidden: bool,
    pub required: bool,
    pub multiple: bool,
    pub last: bool,
    pub global: bool,
}

The description of one argument.

Values are built with ArgInfo::new and the const builder methods, so that fields can be added without breaking existing code.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

id: &'static str

The name of the field, or help and version for the generated flags.

kind: ArgKind

How the argument is given.

short: Option<char>

The short name, without the leading -.

long: Option<&'static str>

The long name, without the leading --.

visible_short_aliases: &'static [char]

The short aliases listed in the help.

short_aliases: &'static [char]

The short aliases hidden from the help.

visible_aliases: &'static [&'static str]

The long aliases listed in the help.

aliases: &'static [&'static str]

The long aliases hidden from the help.

value_name: &'static str

The name of the value, e.g. FILE. Empty for flags.

help: &'static str

The short help. Empty when not set.

long_help: &'static str

The long help. Empty when not set.

possible_values: &'static [&'static str]

The accepted values, from possible_values or a ValueEnum. Empty when any value is accepted.

env: Option<&'static str>

The environment variable the argument falls back to.

hidden: bool

Whether the argument is hidden from the help.

required: bool

Whether the argument must be given.

multiple: bool

Whether the argument can be given several times, e.g. a Count flag or a field collecting repeated values. A repeatable positional argument takes every remaining positional argument.

last: bool

Whether the positional argument is only filled after --.

global: bool

Whether the option is global: also accepted after the subcommands of its command, and listed in their help and completions.

Implementations

impl ArgInfo

pub const fn new(id: &'static str, kind: ArgKind) -> Self

An argument named id, without names, help or values.

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

Sets short.

pub const fn long(self, long: &'static str) -> Self

Sets long.

pub const fn visible_short_aliases(self, aliases: &'static [char]) -> Self

Sets visible_short_aliases.

pub const fn short_aliases(self, aliases: &'static [char]) -> Self

Sets short_aliases.

pub const fn visible_aliases(self, aliases: &'static [&'static str]) -> Self

Sets visible_aliases.

pub const fn aliases(self, aliases: &'static [&'static str]) -> Self

Sets aliases.

pub const fn value_name(self, value_name: &'static str) -> Self

Sets value_name.

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

Sets help.

pub const fn long_help(self, long_help: &'static str) -> Self

Sets long_help.

pub const fn possible_values(self, values: &'static [&'static str]) -> Self

Sets possible_values.

pub const fn env(self, env: &'static str) -> Self

Sets env.

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

Sets hidden.

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

Sets required.

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

Sets multiple.

pub const fn last(self, last: bool) -> Self

Sets last.

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

Sets global.

pub const fn takes_value(&self) -> bool

Whether the argument takes a value: options and positional arguments.

pub const fn is_positional(&self) -> bool

Whether the argument is positional.

pub const fn long_or_short_help(&self) -> &'static str

The long help, or the short help when there is no long help.

Trait Implementations

impl Clone for ArgInfo

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for ArgInfo

impl Debug for ArgInfo

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

Formats the value using the given formatter.

impl Eq for ArgInfo

impl PartialEq for ArgInfo

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ArgInfo