Struct Item 

pub struct Item {

    pub short: Option<char>,
    pub long: Option<&'static str>,
    pub aliases: &'static [&'static str],
    pub negate: Option<&'static str>,
    pub value_name: Option<&'static str>,
    pub help: &'static str,
    pub long_help: &'static str,
    pub heading: Option<&'static str>,
    pub hide: bool,
    pub positional: bool,
    pub required: bool,
    pub multiple: bool,
    pub trailing: bool,
    pub default: Option<&'static str>,
    pub env: Option<&'static str>,
    pub choices: &'static [&'static str],
    pub require_equals: bool,
    pub global: bool,
    pub more_shorts: &'static [char],
    pub plus: Option<char>,
    pub optional_value: bool,
    pub values: usize,
    pub more_values: bool,
    pub hint: Hint,
    pub complete: Option<fn(&str) -> Vec<Candidate>>,
    pub warning: &'static str,
}

A flag or positional.

Fields

short: Option<char>

-c.

long: Option<&'static str>

--name.

aliases: &'static [&'static str]

Other long names it answers to, not shown.

negate: Option<&'static str>

--no-name, the spelling that sets it false.

value_name: Option<&'static str>

The value’s placeholder; None for a switch.

help: &'static str

First paragraph of the description.

long_help: &'static str

The whole description.

heading: Option<&'static str>

Section to list it under instead of “Options”.

hide: bool

Left out of help.

positional: bool

A positional rather than a flag.

required: bool

Must be given.

multiple: bool

Takes several values or occurrences.

trailing: bool

A positional that only takes words after --.

default: Option<&'static str>

The value used when none is given.

env: Option<&'static str>

The environment variable consulted.

choices: &'static [&'static str]

The only values accepted.

require_equals: bool

The value is only taken attached (--name=value), never the next word.

global: bool

Also accepted by every subcommand below.

more_shorts: &'static [char]

Other letters it answers to: -l, -L.

plus: Option<char>

The letter of its +c spelling.

optional_value: bool

The value may be left out.

values: usize

Words each occurrence takes; 1 unless declared values = N.

more_values: bool

It may take more than values (values = 1..): shown as <V>....

hint: Hint

What its value is, for the shell that completes it.

complete: Option<fn(&str) -> Vec<Candidate>>

What its value can be, given what is typed of it: asked when a shell completes it, in place of its choices and its hint.

warning: &'static str

What to know before using it, shown by --help as Warning: …; empty for none.

Implementations

impl Item

pub const EMPTY: Item

A switch with no name. A value written by hand ends in ..Item::EMPTY, and a release that adds a field does not break it.

Trait Implementations

impl Clone for Item

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 Item

impl Debug for Item

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

Formats the value using the given formatter.