Struct CommandLineArgs 

pub struct CommandLineArgs {

    pub help: Option<bool>,
    pub version: Option<bool>,
    pub config_file: Option<PathBuf>,
    pub no_config: bool,
    pub disallow_overwriting_regular_files_via_output_redirection: bool,
    pub command: Option<String>,
    pub exit_on_nonzero_command_exit: bool,
    pub disable_pathname_expansion: bool,
    pub interactive: bool,
    pub inherited_fds: Vec<i32>,
    pub login: bool,
    pub do_not_execute_commands: bool,
    pub no_editing: bool,
    pub no_profile: bool,
    pub no_rc: bool,
    pub do_not_inherit_env: bool,
    pub enabled_options: Vec<String>,
    pub disabled_options: Vec<String>,
    pub enabled_shopt_options: Vec<String>,
    pub disabled_shopt_options: Vec<String>,
    pub posix: bool,
    pub rc_file: Option<PathBuf>,
    pub read_commands_from_stdin: bool,
    pub sh_mode: bool,
    pub exit_after_one_command: bool,
    pub treat_unset_variables_as_error: bool,
    pub verbose: bool,
    pub print_commands_and_arguments: bool,
    pub xtrace_file_path: Option<PathBuf>,
    pub disable_bracketed_paste: bool,
    pub disable_color: bool,
    pub enable_highlighting: bool,
    pub terminal_shell_integration: bool,
    pub zsh_style_hooks: bool,
    pub input_backend: Option<InputBackendType>,
    pub enabled_debug_events: Vec<TraceEvent>,
    pub disabled_events: Vec<TraceEvent>,
    pub script_args: Vec<String>,
}

Parsed command-line arguments for the brush shell.

Fields

help: Option<bool>

Display usage information.

version: Option<bool>

Display shell version.

config_file: Option<PathBuf>

Path to TOML-based brush config file (overrides default location).

no_config: bool

Disable loading of TOML-based brush config file.

disallow_overwriting_regular_files_via_output_redirection: bool

Enable noclobber shell option.

command: Option<String>

Execute the provided command and then exit.

exit_on_nonzero_command_exit: bool

Enable error-on-exit behavior.

disable_pathname_expansion: bool

Disable pathname expansion (also known as filename globbing).

interactive: bool

Run in interactive mode.

inherited_fds: Vec<i32>

Inherit the specified file descriptors injected by the parent process.

login: bool

Make shell act as if it had been invoked as a login shell.

do_not_execute_commands: bool

Do not execute commands.

no_editing: bool

Don’t use readline for input.

no_profile: bool

Don’t process any profile/login files (/etc/profile, ~/.bash_profile, ~/.bash_login, ~/.profile).

no_rc: bool

Don’t process “rc” files if the shell is interactive (e.g., ~/.bashrc, ~/.brushrc).

do_not_inherit_env: bool

Don’t inherit environment variables from the calling process.

enabled_options: Vec<String>

Enable option (set -o option).

disabled_options: Vec<String>

Disable option (set -o option).

enabled_shopt_options: Vec<String>

Enable shopt option.

disabled_shopt_options: Vec<String>

Disable shopt option.

posix: bool

Disable non-POSIX extensions.

rc_file: Option<PathBuf>

Path to the rc file to load in interactive shells (instead of bash.bashrc and ~/.bashrc).

read_commands_from_stdin: bool

Read commands from standard input.

sh_mode: bool

Run in sh compatibility mode, as if run as /bin/sh.

exit_after_one_command: bool

Run only one command and then exit.

treat_unset_variables_as_error: bool

Treat expansion of an unset variable as an error.

verbose: bool

Print input when it’s processed.

print_commands_and_arguments: bool

Print commands as they execute.

xtrace_file_path: Option<PathBuf>

Enable xtrace and configure for the given output file.

disable_bracketed_paste: bool

Disable bracketed paste.

disable_color: bool

Disable colorized output.

enable_highlighting: bool

Enable syntax highlighting in input.

terminal_shell_integration: bool

Enable terminal integration (experimental).

zsh_style_hooks: bool

Enable zsh-style preexec/precmd hooks (experimental).

input_backend: Option<InputBackendType>

Input backend.

enabled_debug_events: Vec<TraceEvent>

Enable debug logging for classes of tracing events.

disabled_events: Vec<TraceEvent>

Disable logging for classes of tracing events (takes same event types as --debug).

script_args: Vec<String>

Path and arguments for script to execute (optional).

Implementations

impl CommandLineArgs

pub fn default_values() -> Self

Returns a CommandLineArgs with all clap-defined default values.

This is useful for detecting which CLI arguments were explicitly provided vs. which retained their default values (e.g., for config file merging).

pub fn is_interactive(&self) -> bool

Returns whether or not the arguments indicate that the shell should run in interactive mode.

Trait Implementations

impl Args for CommandLineArgs

fn group_id() -> Option<Id>

Report the ArgGroup::id for this set of arguments

fn augment_args<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate Self via FromArgMatches::from_arg_matches_mut

fn augment_args_for_update<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate self via FromArgMatches::update_from_arg_matches_mut

impl Clone for CommandLineArgs

fn clone(&self) -> CommandLineArgs

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl CommandFactory for CommandLineArgs

fn command<'b>() -> Command

Build a Command that can instantiate Self.

fn command_for_update<'b>() -> Command

Build a Command that can update self.

impl FromArgMatches for CommandLineArgs

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches, ) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn update_from_arg_matches( &mut self, __clap_arg_matches: &ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

fn update_from_arg_matches_mut( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

impl Parser for CommandLineArgs

fn parse() -> Self

Parse from std::env::args_os(), exit on error.

fn try_parse() -> Result<Self, Error>

Parse from std::env::args_os(), return Err on error.

fn parse_from<I, T>(itr: I) -> Self

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, exit on error.

fn try_parse_from<I, T>(itr: I) -> Result<Self, Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, return Err on error.

fn update_from<I, T>(&mut self, itr: I)

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, exit on error.

fn try_update_from<I, T>(&mut self, itr: I) -> Result<(), Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, return Err on error.