Struct nu_protocol::engine::StackIoGuard

pub struct StackIoGuard<'a> { /* private fields */ }

Methods from Deref<Target = Stack>

pub fn with_env( &mut self, env_vars: &[EnvVars], env_hidden: &HashMap<String, HashSet<String>> )

pub fn get_var(&self, var_id: VarId, span: Span) -> Result<Value, ShellError>

Lookup a variable, erroring if it is not found

The passed-in span will be used to tag the value

pub fn get_var_with_origin( &self, var_id: VarId, span: Span ) -> Result<Value, ShellError>

Lookup a variable, erroring if it is not found

While the passed-in span will be used for errors, the returned value has the span from where it was originally defined

pub fn add_var(&mut self, var_id: VarId, value: Value)

pub fn remove_var(&mut self, var_id: VarId)

pub fn add_env_var(&mut self, var: String, value: Value)

pub fn last_overlay_name(&self) -> Result<String, ShellError>

pub fn captures_to_stack(&self, captures: Vec<(VarId, Value)>) -> Stack

pub fn captures_to_stack_preserve_out_dest( &self, captures: Vec<(VarId, Value)> ) -> Stack

pub fn gather_captures( &self, engine_state: &EngineState, captures: &[VarId] ) -> Stack

pub fn get_env_vars(&self, engine_state: &EngineState) -> HashMap<String, Value>

Flatten the env var scope frames into one frame

pub fn get_stack_env_vars(&self) -> HashMap<String, Value>

Get flattened environment variables only from the stack

pub fn get_stack_overlay_env_vars( &self, overlay_name: &str ) -> HashMap<String, Value>

Get flattened environment variables only from the stack and one overlay

pub fn get_env_var_names(&self, engine_state: &EngineState) -> HashSet<String>

Same as get_env_vars, but returns only the names as a HashSet

pub fn get_env_var( &self, engine_state: &EngineState, name: &str ) -> Option<Value>

pub fn has_env_var(&self, engine_state: &EngineState, name: &str) -> bool

pub fn remove_env_var(&mut self, engine_state: &EngineState, name: &str) -> bool

pub fn has_env_overlay(&self, name: &str, engine_state: &EngineState) -> bool

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

pub fn add_overlay(&mut self, name: String)

pub fn remove_overlay(&mut self, name: &str)

pub fn stdout(&self) -> &OutDest

Returns the OutDest to use for the current command’s stdout.

This will be the pipe redirection if one is set, otherwise it will be the current file redirection, otherwise it will be the process’s stdout indicated by OutDest::Inherit.

pub fn stderr(&self) -> &OutDest

Returns the OutDest to use for the current command’s stderr.

This will be the pipe redirection if one is set, otherwise it will be the current file redirection, otherwise it will be the process’s stderr indicated by OutDest::Inherit.

pub fn pipe_stdout(&self) -> Option<&OutDest>

Returns the OutDest of the pipe redirection applied to the current command’s stdout.

pub fn pipe_stderr(&self) -> Option<&OutDest>

Returns the OutDest of the pipe redirection applied to the current command’s stderr.

pub fn start_capture(&mut self) -> StackCaptureGuard<'_>

Temporarily set the pipe stdout redirection to OutDest::Capture.

This is used before evaluating an expression into a Value.

pub fn use_call_arg_out_dest(&mut self) -> StackCallArgGuard<'_>

Temporarily use the output redirections in the parent scope.

This is used before evaluating an argument to a call.

pub fn push_redirection( &mut self, stdout: Option<Redirection>, stderr: Option<Redirection> ) -> StackIoGuard<'_>

Temporarily apply redirections to stdout and/or stderr.

Trait Implementations

impl<'a> Deref for StackIoGuard<'a>

type Target = Stack

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'a> DerefMut for StackIoGuard<'a>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl Drop for StackIoGuard<'_>

fn drop(&mut self)

Executes the destructor for this type.