Enum menu::Parameter

source ·
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>,
    },
}
Expand description

Describes a parameter to the command

Variants§

§

Mandatory

Fields

§parameter_name: &'a str

A name for this mandatory positional parameter

§help: Option<&'a str>

Help text

A mandatory positional parameter

§

Optional

Fields

§parameter_name: &'a str

A name for this optional positional parameter

§help: Option<&'a str>

Help text

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

§

Named

Fields

§parameter_name: &'a str

The bit that comes after the --

§help: Option<&'a str>

Help text

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

§

NamedValue

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

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

Trait Implementations§

source§

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

source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<'a> RefUnwindSafe for Parameter<'a>

§

impl<'a> Send for Parameter<'a>

§

impl<'a> Sync for Parameter<'a>

§

impl<'a> Unpin for Parameter<'a>

§

impl<'a> UnwindSafe for Parameter<'a>

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for Twhere U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.