Struct SpecFlag 

pub struct SpecFlag {

    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 short: Vec<char>,
    pub long: Vec<String>,
    pub required: bool,
    pub deprecated: Option<String>,
    pub var: bool,
    pub var_min: Option<usize>,
    pub var_max: Option<usize>,
    pub hide: bool,
    pub global: bool,
    pub count: bool,
    pub arg: Option<SpecArg>,
    pub default: Vec<String>,
    pub negate: Option<String>,
    pub env: Option<String>,
}

A CLI flag/option specification.

Flags are optional arguments that start with - (short) or -- (long). They can be boolean switches or accept values.

Example

use usage::SpecFlag;

let flag = SpecFlag::builder()
    .short('v')
    .long("verbose")
    .help("Enable verbose output")
    .build();

Fields

name: String

Internal name for the flag (derived from long/short if not set)

usage: String

Generated usage string (e.g., “-v, –verbose”)

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)

short: Vec<char>

Short flag characters (e.g., ‘v’ for -v)

long: Vec<String>

Long flag names (e.g., “verbose” for –verbose)

required: bool

Whether this flag must be provided

deprecated: Option<String>

Deprecation message if this flag is deprecated

var: bool

Whether this flag can be specified multiple times

var_min: Option<usize>

Minimum number of times this flag must appear (for var flags)

var_max: Option<usize>

Maximum number of times this flag can appear (for var flags)

hide: bool

Whether to hide this flag from help output

global: bool

Whether this flag is available to all subcommands

count: bool

Whether this is a count flag (e.g., -vvv counts as 3)

arg: Option<SpecArg>

Argument specification if this flag takes a value

default: Vec<String>

Default value(s) if the flag is not provided

negate: Option<String>

Negation prefix (e.g., “no-” for –no-verbose)

env: Option<String>

Environment variable that can set this flag’s value

Implementations

impl SpecFlag

pub fn builder() -> SpecFlagBuilder

Create a new builder for SpecFlag

pub fn usage(&self) -> String

Trait Implementations

impl Clone for SpecFlag

fn clone(&self) -> SpecFlag

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SpecFlag

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

Formats the value using the given formatter.

impl Default for SpecFlag

fn default() -> SpecFlag

Returns the “default value” for a type.

impl Display for SpecFlag

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

Formats the value using the given formatter.

impl From<&SpecFlag> for KdlNode

fn from(flag: &SpecFlag) -> KdlNode

Converts to this type from the input type.

impl FromStr for SpecFlag

type Err = UsageErr

The associated error which can be returned from parsing.

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

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

impl Hash for SpecFlag

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 SpecFlag

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 SpecFlag

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 SpecFlag