Struct ArgInfo 

pub struct ArgInfo {
    pub short: Option<String>,
    pub long: Option<String>,
    pub value: Option<String>,
    pub description: String,
    pub default: Option<String>,
    pub required: bool,
    pub env_var: Option<String>,
}

A command-line argument or option.

Fields

short: Option<String>

Short name (e.g., “-h”).

long: Option<String>

Long name (e.g., “–help”).

value: Option<String>

Value placeholder (e.g., “<PORT>”).

description: String

Description.

default: Option<String>

Default value.

required: bool

Whether required.

env_var: Option<String>

Environment variable name.

Implementations

impl ArgInfo

pub fn new(long: impl Into<String>, description: impl Into<String>) -> Self

Create a new argument with long name.

pub fn positional( name: impl Into<String>, description: impl Into<String>, ) -> Self

Create a positional argument.

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

Set short name.

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

Set value placeholder.

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

Set default value.

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

Mark as required.

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

Set environment variable.

pub fn full_name(&self) -> String

Get the full argument name for display.

Trait Implementations

impl Clone for ArgInfo

fn clone(&self) -> ArgInfo

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ArgInfo

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

Formats the value using the given formatter.