Enum nu_plugin_protocol::EngineCall

pub enum EngineCall<D> {
    GetConfig,
    GetPluginConfig,
    GetEnvVar(String),
    GetEnvVars,
    GetCurrentDir,
    AddEnvVar(String, Value),
    GetHelp,
    EnterForeground,
    LeaveForeground,
    GetSpanContents(Span),
    EvalClosure {
        closure: Spanned<Closure>,
        positional: Vec<Value>,
        input: D,
        redirect_stdout: bool,
        redirect_stderr: bool,
    },
    FindDecl(String),
    CallDecl {
        decl_id: DeclId,
        call: EvaluatedCall,
        input: D,
        redirect_stdout: bool,
        redirect_stderr: bool,
    },
}

A remote call back to the engine during the plugin’s execution.

The type parameter determines the input type, for calls that take pipeline data.

Variants

GetConfig

Get the full engine configuration

GetPluginConfig

Get the plugin-specific configuration ($env.config.plugins.NAME)

GetEnvVar(String)

Get an environment variable

GetEnvVars

Get all environment variables

GetCurrentDir

Get current working directory

AddEnvVar(String, Value)

Set an environment variable in the caller’s scope

GetHelp

Get help for the current command

EnterForeground

Move the plugin into the foreground for terminal interaction

LeaveForeground

Move the plugin out of the foreground once terminal interaction has finished

GetSpanContents(Span)

Get the contents of a span. Response is a binary which may not parse to UTF-8

EvalClosure

Evaluate a closure with stream input/output

Fields

closure: Spanned<Closure>

The closure to call.

This may come from a Value::Closure passed in as an argument to the plugin.

positional: Vec<Value>

Positional arguments to add to the closure call

input: D

Input to the closure

redirect_stdout: bool

Whether to redirect stdout from external commands

redirect_stderr: bool

Whether to redirect stderr from external commands

FindDecl(String)

Find a declaration by name

CallDecl

Call a declaration with args

Fields

decl_id: DeclId

The id of the declaration to be called (can be found with FindDecl)

call: EvaluatedCall

Information about the call (head span, arguments, etc.)

input: D

Pipeline input to the call

redirect_stdout: bool

Whether to redirect stdout from external commands

redirect_stderr: bool

Whether to redirect stderr from external commands

Implementations

impl<D> EngineCall<D>

pub fn name(&self) -> &'static str

Get the name of the engine call so it can be embedded in things like error messages

pub fn map_data<T>( self, f: impl FnOnce(D) -> Result<T, ShellError>, ) -> Result<EngineCall<T>, ShellError>

Convert the data type from D to T. The function will not be called if the variant does not contain data.

Trait Implementations

impl<D: Clone> Clone for EngineCall<D>

fn clone(&self) -> EngineCall<D>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<D: Debug> Debug for EngineCall<D>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de, D> Deserialize<'de> for EngineCall<D>

where D: Deserialize<'de>,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<D> Serialize for EngineCall<D>

where D: Serialize,

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.