Struct Arg 

pub struct Arg { /* private fields */ }

Available on crate feature std only.

A single argument a command accepts.

Build one with Arg::flag, Arg::option, or Arg::positional, then attach it with Command::arg. The name is the key used to read the parsed result back out of a Matches.

Examples

use cli_forge::Arg;

let verbose = Arg::flag("verbose").short('v').help("print extra detail");
let output = Arg::option("output").short('o').required(true);
let path = Arg::positional("path").default(".");

Implementations

impl Arg

pub fn flag(name: impl Into<String>) -> Arg

Define a boolean flag, e.g. --verbose. The long form defaults to the name; add a short for a one-letter alias.

Examples

use cli_forge::Arg;
let force = Arg::flag("force").short('f');

pub fn option(name: impl Into<String>) -> Arg

Define a value-taking option, e.g. --output file. Accepts --name v, --name=v, -x v, and -xv at parse time.

Examples

use cli_forge::Arg;
let out = Arg::option("output").short('o').required(true);

pub fn positional(name: impl Into<String>) -> Arg

Define a positional argument, filled by bare values in order.

Examples

use cli_forge::Arg;
let path = Arg::positional("path").default(".");

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

Set a one-letter short form (-x). Ignored for positionals.

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

Override the long form (--name). Defaults to the argument’s name. Ignored for positionals.

pub fn help(self, help: impl Into<String>) -> Arg

Attach help text. Surfaced by the help engine (v0.4.0); stored now so definitions are complete.

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

Require the argument. Parsing fails with ParseError::MissingRequired if it is absent and has no default. Has no effect on flags (a flag is simply present or not).

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

Provide a default value used when an option or positional is omitted. A default makes the argument effectively optional even if required was set.

Trait Implementations

impl Clone for Arg

fn clone(&self) -> Arg

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Arg

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

Formats the value using the given formatter.