Struct OptSpec 

pub struct OptSpec {
    pub name: &'static str,
    pub short: Option<char>,
    pub ty: &'static str,
    pub doc: &'static str,
    pub env: Option<&'static str>,
    pub default: Option<&'static str>,
    pub example: Option<&'static str>,
}

Specification for Opt.

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

Fields

name: &'static str

Option long name (usually kebab-case).

short: Option<char>

Option short name.

ty: &'static str

Value type.

doc: &'static str

Documentation.

env: Option<&'static str>

Environment variable name.

If a non-empty value is set for this environment variable, it will be used as the value of this option when the option is not specified in RawArgs.

default: Option<&'static str>

Default value.

example: Option<&'static str>

Example value (if this is set, the option is considered to be requried when generating the help text).

This is only used if RawArgs::metadata().help_mode is true.

Implementations

impl OptSpec

pub const DEFAULT: Self

The default specification.

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

Makes an OptSpec instance with a specified name (equivalent to noargs::opt(name)).

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

Updates the value of OptSpec::short.

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

Updates the value of OptSpec::ty.

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

Updates the value of OptSpec::doc.

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

Updates the value of OptSpec::env.

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

Updates the value of OptSpec::default.

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

Updates the value of OptSpec::example.

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

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

Trait Implementations

impl Clone for OptSpec

fn clone(&self) -> OptSpec

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OptSpec

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

Formats the value using the given formatter.

impl Default for OptSpec

fn default() -> Self

Returns the “default value” for a type.

impl Hash for OptSpec

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 OptSpec

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

impl Eq for OptSpec

impl StructuralPartialEq for OptSpec