Trait PluginExecutionContext

pub trait PluginExecutionContext: Send + Sync {
    // Required methods
    fn span(&self) -> Span;
    fn signals(&self) -> &Signals;
    fn pipeline_externals_state(&self) -> Option<&Arc<(AtomicU32, AtomicU32)>>;
    fn get_config(&self) -> Result<Arc<Config>, ShellError>;
    fn get_plugin_config(&self) -> Result<Option<Value>, ShellError>;
    fn get_env_var(&self, name: &str) -> Result<Option<&Value>, ShellError>;
    fn get_env_vars(&self) -> Result<HashMap<String, Value>, ShellError>;
    fn get_current_dir(&self) -> Result<Spanned<String>, ShellError>;
    fn add_env_var(
        &mut self,
        name: String,
        value: Value,
    ) -> Result<(), ShellError>;
    fn get_help(&self) -> Result<Spanned<String>, ShellError>;
    fn get_span_contents(
        &self,
        span: Span,
    ) -> Result<Spanned<Vec<u8>>, ShellError>;
    fn eval_closure(
        &self,
        closure: Spanned<Closure>,
        positional: Vec<Value>,
        input: PipelineData,
        redirect_stdout: bool,
        redirect_stderr: bool,
    ) -> Result<PipelineData, ShellError>;
    fn find_decl(&self, name: &str) -> Result<Option<DeclId>, ShellError>;
    fn call_decl(
        &mut self,
        decl_id: DeclId,
        call: EvaluatedCall,
        input: PipelineData,
        redirect_stdout: bool,
        redirect_stderr: bool,
    ) -> Result<PipelineData, ShellError>;
    fn boxed(&self) -> Box<dyn PluginExecutionContext>;
}

Object safe trait for abstracting operations required of the plugin context.

Required Methods

fn span(&self) -> Span

A span pointing to the command being executed

fn signals(&self) -> &Signals

The Signals struct, if present

fn pipeline_externals_state(&self) -> Option<&Arc<(AtomicU32, AtomicU32)>>

The pipeline externals state, for tracking the foreground process group, if present

fn get_config(&self) -> Result<Arc<Config>, ShellError>

Get engine configuration

fn get_plugin_config(&self) -> Result<Option<Value>, ShellError>

Get plugin configuration

fn get_env_var(&self, name: &str) -> Result<Option<&Value>, ShellError>

Get an environment variable from $env

fn get_env_vars(&self) -> Result<HashMap<String, Value>, ShellError>

Get all environment variables

fn get_current_dir(&self) -> Result<Spanned<String>, ShellError>

Get current working directory

fn add_env_var(&mut self, name: String, value: Value) -> Result<(), ShellError>

Set an environment variable

fn get_help(&self) -> Result<Spanned<String>, ShellError>

Get help for the current command

fn get_span_contents(&self, span: Span) -> Result<Spanned<Vec<u8>>, ShellError>

Get the contents of a Span

fn eval_closure( &self, closure: Spanned<Closure>, positional: Vec<Value>, input: PipelineData, redirect_stdout: bool, redirect_stderr: bool, ) -> Result<PipelineData, ShellError>

Evaluate a closure passed to the plugin

fn find_decl(&self, name: &str) -> Result<Option<DeclId>, ShellError>

Find a declaration by name

fn call_decl( &mut self, decl_id: DeclId, call: EvaluatedCall, input: PipelineData, redirect_stdout: bool, redirect_stderr: bool, ) -> Result<PipelineData, ShellError>

Call a declaration with arguments and input

fn boxed(&self) -> Box<dyn PluginExecutionContext>

Create an owned version of the context with 'static lifetime

Implementors

impl<'a> PluginExecutionContext for PluginExecutionCommandContext<'a>