Struct nu_engine::EvaluationContext

pub struct EvaluationContext {
    pub scope: Scope,
    pub host: Arc<Mutex<Box<dyn Host>>>,
    pub current_errors: Arc<Mutex<Vec<ShellError>>>,
    pub ctrl_c: Arc<AtomicBool>,
    pub configs: Arc<Mutex<ConfigHolder>>,
    pub shell_manager: ShellManager,
    pub windows_drives_previous_cwd: Arc<Mutex<HashMap<String, String>>>,
}

Fields

scope: Scope

host: Arc<Mutex<Box<dyn Host>>>

current_errors: Arc<Mutex<Vec<ShellError>>>

ctrl_c: Arc<AtomicBool>

configs: Arc<Mutex<ConfigHolder>>

shell_manager: ShellManager

windows_drives_previous_cwd: Arc<Mutex<HashMap<String, String>>>

Windows-specific: keep track of previous cwd on each drive

Implementations

impl EvaluationContext

pub fn new(
    scope: Scope,
    host: Arc<Mutex<Box<dyn Host>>>,
    current_errors: Arc<Mutex<Vec<ShellError>>>,
    ctrl_c: Arc<AtomicBool>,
    configs: Arc<Mutex<ConfigHolder>>,
    shell_manager: ShellManager,
    windows_drives_previous_cwd: Arc<Mutex<HashMap<String, String>>>
) -> Self

pub fn basic() -> EvaluationContext

pub fn from_args(args: &CommandArgs) -> EvaluationContext

pub fn error(&self, error: ShellError)

pub fn clear_errors(&self)

pub fn get_errors(&self) -> Vec<ShellError>

pub fn configure<T>(
    &mut self,
    config: &dyn Conf,
    block: impl FnOnce(&dyn Conf, &mut Self) -> T
)

pub fn with_host<T>(&self, block: impl FnOnce(&mut dyn Host) -> T) -> T

pub fn with_errors<T>(&self, block: impl FnOnce(&mut Vec<ShellError>) -> T) -> T

pub fn add_commands(&self, commands: Vec<Command>)

pub fn sync_path_to_env(&self)

pub fn is_command_registered(&self, name: &str) -> bool

pub fn load_config(&self, cfg_path: &ConfigPath) -> Result<(), ShellError>

Loads config under cfg_path. If an error occurs while loading the config: The config is not loaded The error is returned After successful loading of the config the startup scripts are run as normal scripts (Errors are printed out, …) After executing the startup scripts, true is returned to indicate successful loading of the config

pub fn reload_config(&self, cfg: &mut NuConfig) -> Result<(), ShellError>

Reloads config with a path of cfg_path. If an error occurs while reloading the config: The config is not reloaded The error is returned

pub fn unload_config(&self, cfg_path: &ConfigPath)

Runs all exit_scripts before unloading the config with path of cfg_path If an error occurs while running exit scripts: The error is added to self.current_errors If no config with path of cfg_path is present, this method does nothing

pub fn run_scripts(&self, scripts: Vec<String>, dir: Option<&Path>)

Runs scripts with cwd of dir. If dir is None, this method does nothing. Each error is added to self.current_errors

Trait Implementations

impl Clone for EvaluationContext

fn clone(&self) -> EvaluationContext

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for EvaluationContext

fn default() -> EvaluationContext

Returns the “default value” for a type.