Struct OptionSpec 

pub struct OptionSpec { /* private fields */ }

Implementations

impl OptionSpec

pub fn flag(long: impl Into<String>) -> Self

pub fn value(long: impl Into<String>) -> Self

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

pub fn optional_value(self) -> Self

pub fn value_name(self, name: impl Into<String>) -> Self

pub fn value_type(self, value_type: ValueType) -> Self

pub fn possible_value(self, value: impl Into<String>) -> Self

pub fn about(self, about: impl Into<String>) -> Self

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

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

pub fn detached_optional_value(self, enabled: bool) -> Self

Allows an optional value to be supplied as the following argument.

Optional values remain attached-only by default because a detached text value may otherwise consume a positional argument. Prefer a bounded ValueType such as ValueType::Bool when enabling this behavior.

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

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

pub fn conflicts_with(self, long: impl Into<String>) -> Self

pub fn requires(self, long: impl Into<String>) -> Self

pub fn env(self, name: impl Into<String>) -> Self

Uses a declared environment variable when argv omits this option.

pub fn default_value(self, value: impl Into<OsString>) -> Self

Uses one fallback value after argv and environment resolution.

pub fn value_kind(self, kind: ValueKind) -> Self

Selects additional native path or network-address validation.

pub fn exclusive_group(self, name: impl Into<String>) -> Self

Joins an at-most-one group. Requirements may reference the group name.

pub fn long(&self) -> &str

pub fn short_name(&self) -> Option<char>

pub fn value_mode(&self) -> ValueMode

pub fn value_name_text(&self) -> &str

pub fn value_type_kind(&self) -> ValueType

pub fn possible_values(&self) -> &[String]

pub fn about_text(&self) -> &str

pub fn is_required(&self) -> bool

pub fn is_repeatable(&self) -> bool

pub fn accepts_detached_optional_value(&self) -> bool

pub fn is_terminal(&self) -> bool

pub fn is_hidden(&self) -> bool

pub fn conflicts(&self) -> &[String]

pub fn requirements(&self) -> &[String]

Trait Implementations

impl Clone for OptionSpec

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OptionSpec

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

Formats the value using the given formatter.

impl Eq for OptionSpec

impl PartialEq for OptionSpec

fn eq(&self, other: &Self) -> bool

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for OptionSpec