Struct SpecFlagBuilder 

pub struct SpecFlagBuilder { /* private fields */ }

Builder for SpecFlag

Implementations

impl SpecFlagBuilder

pub fn new() -> Self

Create a new SpecFlagBuilder

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

Set the flag name

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

Add a short flag character (can be called multiple times)

pub fn shorts(self, chars: impl IntoIterator<Item = char>) -> Self

Add multiple short flags at once

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

Add a long flag name (can be called multiple times)

pub fn longs<I, S>(self, names: I) -> Self

where I: IntoIterator<Item = S>, S: Into<String>,

Add multiple long flags at once

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

Add a default value (can be called multiple times for var flags)

pub fn default_values<I, S>(self, values: I) -> Self

where I: IntoIterator<Item = S>, S: Into<String>,

Add multiple default values at once

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

Set help text

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

Set long help text

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

Set markdown help text

pub fn var(self, is_var: bool) -> Self

Set as variadic (can be specified multiple times)

pub fn var_min(self, min: usize) -> Self

Set minimum count for variadic flag

pub fn var_max(self, max: usize) -> Self

Set maximum count for variadic flag

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

Set as required

pub fn global(self, is_global: bool) -> Self

Set as global (available to subcommands)

pub fn hide(self, is_hidden: bool) -> Self

Set as hidden

pub fn count(self, is_count: bool) -> Self

Set as count flag

pub fn arg(self, arg: SpecArg) -> Self

Set the argument spec for flags that take values

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

Set negate string

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

Set environment variable name

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

Set deprecated message

pub fn build(self) -> SpecFlag

Build the final SpecFlag

Trait Implementations

impl Clone for SpecFlagBuilder

fn clone(&self) -> SpecFlagBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SpecFlagBuilder

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

Formats the value using the given formatter.

impl Default for SpecFlagBuilder

fn default() -> SpecFlagBuilder

Returns the “default value” for a type.