Enum menu::Parameter

pub enum Parameter<'a> {
    Mandatory {
        parameter_name: &'a str,
        help: Option<&'a str>,
    },
    Optional {
        parameter_name: &'a str,
        help: Option<&'a str>,
    },
    Named {
        parameter_name: &'a str,
        help: Option<&'a str>,
    },
    NamedValue {
        parameter_name: &'a str,
        argument_name: &'a str,
        help: Option<&'a str>,
    },
}

Describes a parameter to the command

Variants

Mandatory

A mandatory positional parameter

Fields

parameter_name: &'a str

A name for this mandatory positional parameter

help: Option<&'a str>

Help text

Optional

An optional positional parameter. Must come after the mandatory positional arguments.

Fields

parameter_name: &'a str

A name for this optional positional parameter

help: Option<&'a str>

Help text

Named

An optional named parameter with no argument (e.g. --verbose or --dry-run)

Fields

parameter_name: &'a str

The bit that comes after the --

help: Option<&'a str>

Help text

NamedValue

A optional named parameter with argument (e.g. --mode=foo or --level=3)

Fields

parameter_name: &'a str

The bit that comes after the --

argument_name: &'a str

The bit that comes after the --name=, e.g. INT or FILE. It’s mostly for help text.

help: Option<&'a str>

Help text

Trait Implementations

impl<'a> Debug for Parameter<'a>

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

Formats the value using the given formatter.