Struct FlagSpec 

pub struct FlagSpec {
    pub name: &'static str,
    pub short: Option<char>,
    pub doc: &'static str,
    pub env: Option<&'static str>,
}

Specification for Flag.

Note that noargs does not support flags with only short names.

Fields

name: &'static str

Flag long name (usually kebab-case).

short: Option<char>

Flag short name.

doc: &'static str

Documentation.

env: Option<&'static str>

Environment variable name.

If a non-empty value is set to this variable, this flag is considered to be set.

Implementations

impl FlagSpec

pub const DEFAULT: Self

The default specification.

pub const fn new(name: &'static str) -> Self

Makes an FlagSpec instance with a specified name (equivalent to noargs::flag(name)).

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

Updates the value of FlagSpec::short.

pub const fn doc(self, doc: &'static str) -> Self

Updates the value of FlagSpec::doc.

pub const fn env(self, variable_name: &'static str) -> Self

Updates the value of FlagSpec::env.

pub fn take(self, args: &mut RawArgs) -> Flag

Takes the first Flag instance that satisfies this specification from the raw arguments.

pub fn take_help(self, args: &mut RawArgs) -> Flag

Similar to FlagSpec::take(), but updates the help-related metadata of args when the flag is present.

Specifically, the following code is executed:

args.metadata_mut().help_mode = true;
args.metadata_mut().help_flag_name = Some(flag.spec().name);
if matches!(flag, Flag::Long { .. }) {
    args.metadata_mut().full_help = true;
}

Trait Implementations

impl Clone for FlagSpec

fn clone(&self) -> FlagSpec

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FlagSpec

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

Formats the value using the given formatter.

impl Default for FlagSpec

fn default() -> Self

Returns the “default value” for a type.

impl Hash for FlagSpec

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for FlagSpec

fn eq(&self, other: &FlagSpec) -> 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 Copy for FlagSpec

impl Eq for FlagSpec

impl StructuralPartialEq for FlagSpec