Struct ClosureEvalOnce

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

ClosureEvalOnce is used to evaluate a closure a single time.

ClosureEvalOnce has a builder API. It is first created via ClosureEvalOnce::new, then has arguments added via ClosureEvalOnce::add_arg, and then can be run using ClosureEvalOnce::run_with_input.

let result = ClosureEvalOnce::new(engine_state, stack, closure)
    .add_arg(value)
    .run_with_input(PipelineData::Empty);

Many closures follow a simple, common scheme where the pipeline input and the first argument are the same value. In this case, use ClosureEvalOnce::run_with_value:

let result = ClosureEvalOnce::new(engine_state, stack, closure).run_with_value(value);

Implementations

impl<'a> ClosureEvalOnce<'a>

pub fn new( engine_state: &'a EngineState, stack: &Stack, closure: Closure, ) -> Self

Create a new ClosureEvalOnce.

pub fn debug(self, debug: bool) -> Self

Sets whether to enable debugging when evaluating the closure.

By default, this is controlled by the EngineState used to create this ClosureEvalOnce.

pub fn add_arg(self, value: Value) -> Self

Add an argument Value to the closure.

Multiple add_arg calls can be chained together, but make sure that arguments are added based on their positional order.

pub fn run_with_input( self, input: PipelineData, ) -> Result<PipelineData, ShellError>

Run the closure, passing the given PipelineData as input.

Any arguments should be added beforehand via add_arg.

pub fn run_with_value(self, value: Value) -> Result<PipelineData, ShellError>

Run the closure using the given Value as both the pipeline input and the first argument.

Using this function after or in combination with add_arg is most likely an error. This function is equivalent to self.add_arg(value) followed by self.run_with_input(value.into_pipeline_data()).