Struct SpecArgBuilder 

pub struct SpecArgBuilder { /* private fields */ }

Builder for SpecArg

Implementations

impl SpecArgBuilder

pub fn new() -> SpecArgBuilder

Create a new SpecArgBuilder

pub fn surface(self, surface: impl Into<String>) -> SpecArgBuilder

Label the audience or compatibility surface this argument belongs to.

pub fn available_if(self, condition: impl Into<String>) -> SpecArgBuilder

Add a descriptive availability condition.

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

Set the argument name

pub fn sigil(self, sigil: impl Into<String>) -> SpecArgBuilder

Classify this positional by a leading token prefix and strip it on binding.

pub fn value_names<I, S>(self, names: I) -> SpecArgBuilder

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

Set the ordered placeholders for a fixed-arity value.

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

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

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

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

Add multiple default values at once

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

Set help text

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

Set long help text

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

Set markdown help text

pub fn note(self, text: impl Into<String>) -> SpecArgBuilder

Add a semantic note rendered in help and generated documentation.

pub fn warning(self, text: impl Into<String>) -> SpecArgBuilder

Add a semantic warning rendered in help and generated documentation.

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

Set as variadic (accepts multiple values)

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

Set minimum count for variadic argument

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

Set maximum count for variadic argument

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

Set as required

pub fn requires<I, S>(self, selectors: I) -> SpecArgBuilder

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

Add arguments that must be satisfied when this positional is present.

pub fn required_if_any<I, S>(self, selectors: I) -> SpecArgBuilder

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

Add selectors whose presence makes this positional required.

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

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

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

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

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

pub fn required_unless_any<I, S>(self, selectors: I) -> SpecArgBuilder

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

Add selectors where any presence waives this positional’s requirement.

pub fn required_unless_all<I, S>(self, selectors: I) -> SpecArgBuilder

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

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

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

Set as hidden

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

Set environment variable name Heading to list this under in help output.

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

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

Add an environment fallback, consulted after the canonical variable.

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

Add a deprecated environment alias, consulted after ordinary fallbacks.

pub fn double_dash(self, behavior: SpecDoubleDashChoices) -> SpecArgBuilder

Set the double-dash behavior

pub fn choices<I, S>(self, choices: I) -> SpecArgBuilder

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

Set choices for this argument

pub fn validate(self, expression: impl Into<String>) -> SpecArgBuilder

Set a portable expr expression that must accept each raw value.

pub fn validate_error(self, message: impl Into<String>) -> SpecArgBuilder

Set the message reported when validation returns false.

pub fn choices_run(self, run: impl Into<String>) -> SpecArgBuilder

Take further choices from the lines a shell command prints (choices run=).

The command runs when a value is checked, a word is completed, or a running program shows its help; generated docs and code describe it without running it.

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

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

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

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

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

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

pub fn complete(self, complete: SpecComplete) -> SpecArgBuilder

Attach a completer to this argument itself, the builder form of a complete node written inside arg. It wins over a complete found by name. build sets the completer’s name to the argument’s, lowercased, replacing any name it was given.

pub fn build(self) -> SpecArg

Build the final SpecArg

Trait Implementations

impl Clone for SpecArgBuilder

fn clone(&self) -> SpecArgBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SpecArgBuilder

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

Formats the value using the given formatter.

impl Default for SpecArgBuilder

fn default() -> SpecArgBuilder

Returns the “default value” for a type.