Struct SpecArg 

pub struct SpecArg {

    pub name: String,
    pub usage: String,
    pub help: Option<String>,
    pub help_long: Option<String>,
    pub help_md: Option<String>,
    pub help_first_line: Option<String>,
    pub required: bool,
    pub double_dash: SpecDoubleDashChoices,
    pub var: bool,
    pub var_min: Option<usize>,
    pub var_max: Option<usize>,
    pub hide: bool,
    pub default: Vec<String>,
    pub choices: Option<SpecChoices>,
    pub env: Option<String>,
}

A positional argument specification.

Arguments are positional values passed to a command without a flag prefix. They can be required or optional, and can accept multiple values (variadic).

Example

use usage::SpecArg;

let arg = SpecArg::builder()
    .name("file")
    .required(true)
    .help("Input file to process")
    .build();

Fields

name: String

Name of the argument (used in help text)

usage: String

Generated usage string (e.g., “” or “file”)

help: Option<String>

Short help text shown in command listings

help_long: Option<String>

Extended help text shown with –help

help_md: Option<String>

Markdown-formatted help text

help_first_line: Option<String>

First line of help text (auto-generated)

required: bool

Whether this argument must be provided

double_dash: SpecDoubleDashChoices

How to handle the “–” separator

var: bool

Whether this argument accepts multiple values

var_min: Option<usize>

Minimum number of values for variadic arguments

var_max: Option<usize>

Maximum number of values for variadic arguments

hide: bool

Whether to hide this argument from help output

default: Vec<String>

Default value(s) if the argument is not provided

choices: Option<SpecChoices>

Valid choices for this argument

env: Option<String>

Environment variable that can provide this argument’s value

Implementations

impl SpecArg

pub fn builder() -> SpecArgBuilder

Create a new builder for SpecArg

impl SpecArg

pub fn usage(&self) -> String

Trait Implementations

impl Clone for SpecArg

fn clone(&self) -> SpecArg

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SpecArg

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

Formats the value using the given formatter.

impl Default for SpecArg

fn default() -> SpecArg

Returns the “default value” for a type.

impl Display for SpecArg

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

Formats the value using the given formatter.

impl From<&SpecArg> for KdlNode

fn from(arg: &SpecArg) -> Self

Converts to this type from the input type.

impl From<&str> for SpecArg

fn from(input: &str) -> Self

Converts to this type from the input type.

impl FromStr for SpecArg

type Err = UsageErr

The associated error which can be returned from parsing.

fn from_str(input: &str) -> Result<Self, UsageErr>

Parses a string s to return a value of this type.

impl Hash for SpecArg

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 SpecArg

fn eq(&self, other: &Self) -> 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 Serialize for SpecArg

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for SpecArg