Struct RunFunction 

pub struct RunFunction<S>(pub for<'a> fn(&'a mut Env<S>, Rc<Function<S>>, Vec<Field>, Option<fn(&mut Env<S>) -> Pin<Box<dyn Future<Output = ()> + '_>>>) -> Pin<Box<dyn Future<Output = Result<()>> + 'a>>);

Wrapper for a function that runs a shell function

This struct declares a function type that runs a shell function. It is used to inject command execution behavior into the shell environment. An instance of this struct can be stored in the shell environment (Env::any) and used by modules that need to run shell functions.

The wrapped function takes the following arguments:

1. A mutable reference to the shell environment (&'a mut Env)
2. A reference-counted pointer to the shell function to be executed (Rc<Function>)
3. A vector of fields representing the arguments to be passed to the function (Vec<Field>)
   • This should not be empty; the first element is the function name and the rest are the actual arguments.
4. An optional environment preparation hook (Option<fn(&mut Env) -> Pin<Box<dyn Future<Output = ()>>>>)
   • This hook is called after setting up the local variable context. It can inject additional setup logic or modify the environment before the function is executed.

The function returns a future that resolves to a Result indicating the outcome of the function execution.

The most standard implementation of this type is provided in the yash-semantics crate:

fn register_run_function<S: 'static>(env: &mut Env<S>) {
    env.any.insert(Box::new(RunFunction::<S>(|env, function, fields, env_prep_hook| {
        Box::pin(async move {
            yash_semantics::command::simple_command::execute_function_body(
                env, function, fields, env_prep_hook
            ).await
        })
    })));
}

Tuple Fields

0: for<'a> fn(&'a mut Env<S>, Rc<Function<S>>, Vec<Field>, Option<fn(&mut Env<S>) -> Pin<Box<dyn Future<Output = ()> + '_>>>) -> Pin<Box<dyn Future<Output = Result<()>> + 'a>>

Trait Implementations

impl<S> Clone for RunFunction<S>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<S> Debug for RunFunction<S>

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

Formats the value using the given formatter.

impl<S> Copy for RunFunction<S>