Struct Engine 

pub struct Engine {
    pub state: EngineState,
}

Fields

state: EngineState

Implementations

impl Engine

pub fn new() -> Result<Self, Error>

pub fn add_commands( &mut self, commands: Vec<Box<dyn Command>>, ) -> Result<(), Error>

pub fn add_alias(&mut self, name: &str, target: &str) -> Result<(), Error>

pub fn eval( &self, input: PipelineData, expression: String, ) -> Result<PipelineData, String>

pub fn parse_closure( &mut self, script: &str, ) -> Result<Closure, Box<ShellError>>

pub fn add_module( &mut self, name: &str, content: &str, ) -> Result<(), Box<ShellError>>

pub fn with_env_vars( self, vars: impl IntoIterator<Item = (String, String)>, ) -> Result<Self, Error>

pub fn set_append_meta(&mut self, meta: &JsonValue)

Set the base metadata stamped on frames this engine’s .append writes (service_id, {action_id, frame_id}, …). Injected as $env so the .append decl stays instance-independent. See append_command.

pub fn run_closure_in_job( &mut self, closure: &Closure, args: Vec<Value>, pipeline_input: Option<PipelineData>, job_name: impl Into<String>, ) -> Result<PipelineData, Box<ShellError>>

pub fn eval_closure_no_job( &mut self, closure: &Closure, args: Vec<Value>, pipeline_input: Option<PipelineData>, ) -> Result<PipelineData, Box<ShellError>>

Evaluate a closure WITHOUT creating and registering a fresh ThreadJob per call. run_closure_in_job allocates an mpsc channel, builds a ThreadJob, locks self.state.jobs and add_jobs it – and never removes it – on every invocation. In a hot per-frame actor loop that churn (plus the unbounded jobs-table growth) dominated the cost. The caller is expected to have attached a single long-lived background job to self.state once (see the actor EngineWorker); this method just sets up the stack, injects positional args, and evaluates.

pub fn attach_background_job(&mut self, name: impl Into<String>)

Attach a single long-lived background ThreadJob to this engine’s state. Call once before a hot eval loop so eval_closure_no_job can skip per-call job creation. Signals still propagate (the job shares self.state.signals()).

pub fn kill_job_by_name(&self, name: &str)

Kill the background ThreadJob whose name equals name.

Trait Implementations

impl Clone for Engine

fn clone(&self) -> Engine

Returns a duplicate of the value.

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

Performs copy-assignment from source.