Struct OptionSpec 

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

Specification of an option

This structure may contain the following properties:

• Short option name (a single character)
• Long option name (a string)
• Whether this option takes an argument

All of these are optional, but either or both of the short and long names should be set for the option spec to have meaningful effect.

Implementations

impl OptionSpec<'static>

pub const fn new() -> Self

Creates a new empty option spec.

impl OptionSpec<'_>

pub const fn get_short(&self) -> Option<char>

Returns the short option name.

pub fn set_short(&mut self, name: char)

Gives a short name for this option.

The name should not be a hyphen.

pub const fn short(self, name: char) -> Self

Chained version of set_short

impl<'a> OptionSpec<'a>

pub const fn get_long(&self) -> Option<&'a str>

Returns the long option name.

pub fn set_long(&mut self, name: &'a str)

Gives a long name for this option.

The name should not start with "--" or include "=".

pub const fn long(self, name: &'a str) -> Self

Chained version of set_long

impl OptionSpec<'_>

pub const fn get_argument(&self) -> OptionArgumentSpec

Returns whether this option takes an argument.

pub fn set_argument(&mut self, argument: OptionArgumentSpec)

Specifies whether this option takes an argument.

pub const fn argument(self, argument: OptionArgumentSpec) -> Self

Chained version of set_argument

Trait Implementations

impl<'a> Clone for OptionSpec<'a>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for OptionSpec<'a>

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

Formats the value using the given formatter.

impl<'a> Default for OptionSpec<'a>

fn default() -> OptionSpec<'a>

Returns the “default value” for a type.

impl Display for OptionSpec<'_>

Returns the option name like -f or --foo.

If the spec has both short and long names, the result is like -f/--foo. If the spec has neither of them, the result is ?.

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

Formats the value using the given formatter.

impl<'a> PartialEq for OptionSpec<'a>

fn eq(&self, other: &OptionSpec<'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> Copy for OptionSpec<'a>

impl<'a> Eq for OptionSpec<'a>

impl<'a> StructuralPartialEq for OptionSpec<'a>