Struct SimpleCommand 

pub struct SimpleCommand<'a, SE: ShellExtensions> {
    pub params: ExecutionParameters,
    pub command_name: String,
    pub args: Vec<CommandArg>,
    pub use_functions: bool,
    pub path_dirs: Option<Vec<PathBuf>>,
    pub process_group_id: Option<i32>,
    pub argv0: Option<String>,
    /* private fields */
}

Represents a simple command to be executed.

Fields

params: ExecutionParameters

The execution parameters for the command.

command_name: String

The name of the command to execute.

args: Vec<CommandArg>

The arguments to the command, including the command itself.

use_functions: bool

Whether to consider shell functions when looking up the command name. If true, shell functions will be checked; if false, they will be ignored.

path_dirs: Option<Vec<PathBuf>>

Optional list of directories to search for external commands. If left None, the default search logic will be used.

process_group_id: Option<i32>

The process group ID to use for externally executed commands. This may be None, in which case the default behavior will be used.

argv0: Option<String>

Optional override for the argv[0] value presented to an externally spawned process. When None, command_name is used.

Implementations

impl<'a, SE: ShellExtensions> SimpleCommand<'a, SE>

pub fn new<I>( shell: ShellForCommand<'a, SE>, params: ExecutionParameters, command_name: String, args: I, ) -> Self

where I: IntoIterator<Item = CommandArg>,

Creates a new SimpleCommand instance.

Arguments

• shell - The shell in which to execute the command.
• params - The execution parameters for the command.
• command_name - The name of the command to execute.
• args - The arguments to the command, including the command itself.

pub async fn execute(self) -> Result<ExecutionSpawnResult, Error>

Executes the simple command.

The command may be a builtin, a shell function, or an externally executed command. This function’s implementation is responsible for dispatching it appropriately according to the context provided.

Errors

• ErrorKind::CommandNotFound if the name is not a builtin or function and is not found in the search path.
• Any error from starting a builtin, function, or external process; for example ErrorKind::FailedToExecuteCommand or ErrorKind::WorkingDirMissing when an external command cannot be spawned.

Panics

Does not panic in practice: the unwrap runs only after the builtin lookup was checked to be Some.