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 required_if(self, flag: impl Into<String>) -> Self

Add a flag whose presence makes this flag required

pub fn required_if_any<I, S>(self, flags: I) -> Self

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

Add flags whose presence makes this flag required

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

Add a selector/value condition that makes this flag required.

pub fn required_if_eq_all<I, S, V>(self, conditions: I) -> Self

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

Set selector/value conditions which must all match to require this flag.

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

Add a flag whose absence makes this flag required

pub fn required_unless_any<I, S>(self, flags: I) -> Self

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

Add flags where the absence of all of them makes this flag required

pub fn required_unless_all<I, S>(self, flags: I) -> Self

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

Add selectors which must all be present to waive this flag’s requirement.

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 allow_hyphen_values(self, allow: bool) -> Self

Allow this flag’s value to start with -

pub fn require_equals(self, require: bool) -> Self

Require --flag=value and refuse --flag value.

pub fn value_optional(self, optional: bool) -> Self

Allow this flag to be present without a value.

pub fn bool_value(self, enabled: bool) -> Self

Allow --flag=true and --flag=false on a boolean switch.

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

Value used when the flag is present but no value is given.

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 override_with(self, flag: impl Into<String>) -> Self

Add a flag that this flag mutually overrides

pub fn overrides_with<I, S>(self, flags: I) -> Self

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

Add flags that this flag mutually overrides

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

Add a flag that must also be given when this one is

pub fn requires<I, S>(self, flags: I) -> Self

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

Add flags that must also be given when this one is

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

Add a flag required when this flag is explicitly given value

pub fn requires_ifs<I, V, S>(self, requirements: I) -> Self

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

Add value-conditional flag requirements

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

Bind value on this flag when selector is present.

clap’s default_value_if(id, ArgPredicate::IsPresent, value).

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

Bind value on this flag when selector is explicitly when.

clap’s default_value_if(id, ArgPredicate::Equals(when), value).

pub fn default_ifs<I>(self, conditions: I) -> Self

where I: IntoIterator<Item = SpecDefaultIf>,

Add several conditional defaults, in first-match-wins order.

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

Heading to list this under in help output.

pub fn action(self, action: SpecFlagAction) -> Self

Make this flag request help or version output instead of binding a value.

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

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

Add an environment variable fallback, consulted in declaration order.

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

Add a deprecated environment variable alias.

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

Set deprecated message

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

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

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

Set the rendered usage string. build derives this when unset.

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

Set the first line of help text. Derived from help when unset.

pub fn effect(self, effect: SpecCommandEffect) -> Self

Raise the command’s effect when this flag is supplied.

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.