Struct Argument 

pub struct Argument<'a> { /* private fields */ }

Stores the characteristics of the name command line argument.

Implementations

impl<'a> Argument<'a>

pub fn new(name: &'a str) -> Argument<'a>

Create a new Argument that keeps the necessary information for an argument.

pub fn required(self, required: bool) -> Self

Set if the argument must be provided by user.

pub fn requires(self, other_arg: &'a str) -> Self

Add other_arg as a required parameter when self is specified.

pub fn forbids(self, args: Vec<&'a str>) -> Self

Add other_arg as a forbidden parameter when self is specified.

pub fn takes_value(self, takes_value: bool) -> Self

If takes_value is true, then the user must provide a value for the argument, otherwise that argument is a flag.

pub fn allow_multiple(self, allow_multiple: bool) -> Self

If allow_multiple is true, then the user can provide multiple values for the argument (e.g –arg val1 –arg val2). It sets the takes_value option to true, so the user must provides at least one value.

pub fn default_value(self, default_value: &'a str) -> Self

Keep a default value which will be used if the user didn’t provide a value for the argument.

pub fn help(self, help: &'a str) -> Self

Set the information that will be displayed for the argument when user passes --help flag.

Trait Implementations

impl<'a> Clone for Argument<'a>

fn clone(&self) -> Argument<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Argument<'a>

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

Formats the value using the given formatter.

impl<'a> PartialEq for Argument<'a>

fn eq(&self, other: &Argument<'a>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a> Eq for Argument<'a>

impl<'a> StructuralPartialEq for Argument<'a>