Struct SpecCommandBuilder 

pub struct SpecCommandBuilder { /* private fields */ }

Builder for SpecCommand

Implementations

impl SpecCommandBuilder

pub fn new() -> Self

Create a new SpecCommandBuilder

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

Set the command name

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

Add an alias (can be called multiple times)

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

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

Add multiple aliases at once

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

Add a hidden alias (can be called multiple times)

pub fn hidden_aliases<I, S>(self, aliases: I) -> Self

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

Add multiple hidden aliases at once

pub fn flag(self, flag: SpecFlag) -> Self

Add a flag to the command

pub fn flags(self, flags: impl IntoIterator<Item = SpecFlag>) -> Self

Add multiple flags at once

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

Add an argument to the command

pub fn args(self, args: impl IntoIterator<Item = SpecArg>) -> Self

Add multiple arguments 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 hide(self, is_hidden: bool) -> Self

Set as hidden

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

Set subcommand required

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

Set the heading for this command’s subcommand list.

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

Set the synopsis placeholder for a subcommand.

pub fn term_width(self, width: usize) -> Self

Set a fixed help width. Zero disables wrapping.

pub fn max_term_width(self, width: usize) -> Self

Cap detected terminal width when no fixed width is set. Zero disables the cap.

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

Forward an unmatched word as an external command plus the rest of argv

pub fn disable_help_flag(self, disabled: bool) -> Self

Enable or disable the synthesized --help and -h flags.

pub fn disable_help_subcommand(self, disabled: bool) -> Self

Enable or disable the synthesized help subcommand route.

pub fn disable_version_flag(self, disabled: bool) -> Self

Enable or disable the synthesized --version and -V flags.

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

Set whether a later scalar flag occurrence replaces an earlier one.

Enabled by default. Set false to reject duplicate scalar flags.

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

Set whether selecting a subcommand suppresses this command’s requirements.

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

Set whether arguments on this command exclude a later subcommand.

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

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

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

Set what running this command does to the world

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

Set restart token for resetting argument parsing e.g., mise run lint ::: test ::: check with restart_token=“:::”

pub fn subcommand(self, cmd: SpecCommand) -> Self

Add a subcommand (can be called multiple times)

pub fn subcommands(self, cmds: impl IntoIterator<Item = SpecCommand>) -> Self

Add multiple subcommands at once

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

Set before_help text (displayed before the help message)

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

Set before_help_long text

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

Set before_help markdown text

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

Set after_help text (displayed after the help message)

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

Set after_help_long text

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

Set after_help markdown text

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

Add an example (can be called multiple times)

pub fn example_with_help( self, code: impl Into<String>, header: impl Into<String>, help: impl Into<String>, ) -> Self

Add an example with header and help text

pub fn build(self) -> SpecCommand

Build the final SpecCommand

Trait Implementations

impl Clone for SpecCommandBuilder

fn clone(&self) -> SpecCommandBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SpecCommandBuilder

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

Formats the value using the given formatter.

impl Default for SpecCommandBuilder

fn default() -> SpecCommandBuilder

Returns the “default value” for a type.