Struct ParameterInfo 

pub struct ParameterInfo {
    pub anchor: String,
    pub name: String,
    pub display: String,
    pub display_names: String,
    pub description: Option<String>,
    pub required: bool,
    pub multiple: bool,
    pub takes_value: bool,
    pub value_names: Vec<String>,
    pub default_values: Vec<String>,
    pub env: Option<String>,
    pub possible_values: Vec<String>,
}

Information available to parameter formatting callbacks.

Fields

anchor: String

Stable anchor id for this parameter.

name: String

clap argument id.

display: String

Full display form, such as -c <CONFIG>, --config <CONFIG>.

display_names: String

Display form without values, such as -c, --config.

description: Option<String>

Parameter description, if one is configured.

required: bool

Whether this parameter is required.

multiple: bool

Whether this parameter accepts multiple occurrences or values.

takes_value: bool

Whether this parameter takes a value.

value_names: Vec<String>

clap value names.

default_values: Vec<String>

clap default values.

env: Option<String>

Environment variable name, if one is configured.

possible_values: Vec<String>

Possible values exposed by the clap value parser.

Trait Implementations

impl Clone for ParameterInfo

fn clone(&self) -> ParameterInfo

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ParameterInfo

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

Formats the value using the given formatter.