Struct brush_core::Shell

pub struct Shell {

    pub traps: TrapHandlerConfig,
    pub open_files: OpenFiles,
    pub working_dir: PathBuf,
    pub env: ShellEnvironment,
    pub funcs: FunctionEnv,
    pub options: RuntimeOptions,
    pub jobs: JobManager,
    pub aliases: HashMap<String, String>,
    pub last_exit_status: u8,
    pub depth: usize,
    pub positional_parameters: Vec<String>,
    pub shell_name: Option<String>,
    pub script_call_stack: VecDeque<String>,
    pub function_call_stack: VecDeque<FunctionCall>,
    pub directory_stack: Vec<PathBuf>,
    pub current_line_number: u32,
    pub completion_config: Config,
    pub builtins: HashMap<String, Registration>,
}

Represents an instance of a shell.

Fields

traps: TrapHandlerConfig

Trap handler configuration for the shell.

open_files: OpenFiles

Manages files opened and accessible via redirection operators.

working_dir: PathBuf

The current working directory.

env: ShellEnvironment

The shell environment, containing shell variables.

funcs: FunctionEnv

Shell function definitions.

options: RuntimeOptions

Runtime shell options.

jobs: JobManager

State of managed jobs.

aliases: HashMap<String, String>

Shell aliases.

last_exit_status: u8

The status of the last completed command.

depth: usize

Clone depth from the original ancestor shell.

positional_parameters: Vec<String>

Positional parameters ($1 and beyond)

shell_name: Option<String>

Shell name

script_call_stack: VecDeque<String>

Script call stack.

function_call_stack: VecDeque<FunctionCall>

Function call stack.

directory_stack: Vec<PathBuf>

Directory stack used by pushd et al.

current_line_number: u32

Current line number being processed.

completion_config: Config

Completion configuration.

builtins: HashMap<String, Registration>

Shell built-in commands.

Implementations

impl Shell

pub async fn new(options: &CreateOptions) -> Result<Shell, Error>

Returns a new shell instance created with the given options.

Arguments

• options - The options to use when creating the shell.

pub async fn source<S: AsRef<str>>( &mut self, path: &Path, args: &[S], params: &ExecutionParameters, ) -> Result<ExecutionResult, Error>

Source the given file as a shell script, returning the execution result.

Arguments

• path - The path to the file to source.
• args - The arguments to pass to the script as positional parameters.
• params - Execution parameters.

pub async fn source_file<S: AsRef<str>>( &mut self, file: &File, source_info: &SourceInfo, args: &[S], params: &ExecutionParameters, ) -> Result<ExecutionResult, Error>

Source the given file as a shell script, returning the execution result.

Arguments

• file - The file to source.
• source_info - Information about the source of the script.
• args - The arguments to pass to the script as positional parameters.
• params - Execution parameters.

pub async fn invoke_function( &mut self, name: &str, args: &[&str], ) -> Result<u8, Error>

Invokes a function defined in this shell, returning the resulting exit status.

Arguments

• name - The name of the function to invoke.
• args - The arguments to pass to the function.

pub async fn run_string( &mut self, command: String, params: &ExecutionParameters, ) -> Result<ExecutionResult, Error>

Executes the given string as a shell program, returning the resulting exit status.

Arguments

• command - The command to execute.
• params - Execution parameters.

pub fn parse_string(&self, s: String) -> Result<Program, ParseError>

Parses the given string as a shell program, returning the resulting Abstract Syntax Tree for the program.

Arguments

• s - The string to parse as a program.

pub async fn basic_expand_string<S: AsRef<str>>( &mut self, s: S, ) -> Result<String, Error>

Applies basic shell expansion to the provided string.

Arguments

• s - The string to expand.

pub async fn full_expand_and_split_string<S: AsRef<str>>( &mut self, s: S, ) -> Result<Vec<String>, Error>

Applies full shell expansion and field splitting to the provided string; returns a sequence of fields.

Arguments

• s - The string to expand and split.

pub fn default_exec_params(&self) -> ExecutionParameters

Returns the default execution parameters for this shell.

pub async fn run_script<S: AsRef<str>>( &mut self, script_path: &Path, args: &[S], ) -> Result<ExecutionResult, Error>

Executes the given script file, returning the resulting exit status.

Arguments

• script_path - The path to the script file to execute.
• args - The arguments to pass to the script as positional parameters.

pub async fn run_program( &mut self, program: Program, params: &ExecutionParameters, ) -> Result<ExecutionResult, Error>

Executes the given parsed shell program, returning the resulting exit status.

Arguments

• program - The program to execute.
• params - Execution parameters.

pub async fn compose_prompt(&mut self) -> Result<String, Error>

Composes the shell’s prompt, applying all appropriate expansions.

pub fn last_result(&self) -> u8

Returns the exit status of the last command executed in this shell.

pub fn get_history_file_path(&self) -> Option<PathBuf>

Returns the path to the history file used by the shell, if one is set.

pub async fn get_completions( &mut self, input: &str, position: usize, ) -> Result<Completions, Error>

Generates command completions for the shell.

Arguments

• input - The input string to generate completions for.
• position - The position in the input string to generate completions at.

pub fn stdout(&self) -> OpenFile

Returns a value that can be used to write to the shell’s currently configured standard output stream using write! at al.

pub fn stderr(&self) -> OpenFile

Returns a value that can be used to write to the shell’s currently configured standard error stream using write! et al.

pub fn check_for_completed_jobs(&mut self) -> Result<(), Error>

Checks for completed jobs in the shell, reporting any changes found.

Trait Implementations

impl Clone for Shell

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.