Struct BashCliOption 

pub struct BashCliOption {
    pub long: String,
    pub short: Option<char>,
    pub var_name: String,
    pub default: Option<String>,
    pub has_arg: bool,
    pub help: String,
    pub required: bool,
}

A command-line option for the generated argument parser.

Fields

long: String

Long option name (e.g. “verbose”).

short: Option<char>

Short option character (e.g. ‘v’), if any.

var_name: String

Variable name to store the value in.

default: Option<String>

Default value (empty string means no default).

has_arg: bool

Whether the option takes an argument.

help: String

Help text.

required: bool

Whether the option is required.

Implementations

impl BashCliOption

pub fn flag(long: &str, short: Option<char>, var_name: &str, help: &str) -> Self

Create a boolean flag (no argument).

pub fn arg( long: &str, short: Option<char>, var_name: &str, default: Option<&str>, help: &str, ) -> Self

Create an option that takes an argument.

pub fn required(self) -> Self

Mark this option as required.

Trait Implementations

impl Clone for BashCliOption

fn clone(&self) -> BashCliOption

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BashCliOption

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

Formats the value using the given formatter.