More flexible chained api

[NikVolf]

in addition to:

https://pepyakin.github.io/wasmi/wasmi/struct.ModuleRef.html#method.invoke_export

used in the following way

        instance.invoke_export(
            "test",
            &[],
            &mut NopExternals,
        ).expect("failed to execute export")

something like

instance.export("test").with_externals(&mut NopExternals).with_args(&[]).invoke()

?

[pepyakin]

That is very good idea actually!

Why?
Because result of invoking of a function might yield only two outcomes:

• return a result
• trap

However, the docs at the invoke_export actually give a glimpse of a problem:

Returns `Err` if:

- there are no export with a given name or this export is not a function,
- given arguments doesn't match to function signature,
- trap occured at the execution time,

So in other words, today, we have invoke_index that returns an wasmi::Error which includes various variants that just can't happen in result of invoking a function.

[pepyakin]

First step to implement this is in #29

[bddap]

How does this look for a start?

instance
    .export_by_name(func_name)?
    .as_func()?
    .with_externals(&mut NopExternals)
    .with_args(&args)?
    .invoke()
    .ok()?;

export_by_name() -> Option<ExternVal> and as_func() -> Option<&FuncRef> already exist.

The rest could be implemented by adding the following to func.rs:

impl FuncRef {
    pub fn with_externals<'a, E: Externals>(
        &'a self,
        externals: &'a mut E,
    ) -> BoundExternalsFunc<'a, E> {
        BoundExternalsFunc {
            func_instance: self,
            externals,
        }
    }
}

/// First step in chained function calling pattern.                                                                                  
pub struct BoundExternalsFunc<'a, E: Externals + 'a> {
    func_instance: &'a FuncRef,
    externals: &'a mut E,
}

impl<'a, E: Externals> BoundExternalsFunc<'a, E> {
    pub fn with_args(self, args: &'a [RuntimeValue]) -> Option<BoundFunc<'a, E>> {
        BoundFunc::new(self.func_instance, self.externals, args)
    }
}

/// FuncRef with verified arguments.                                                                                                 
pub struct BoundFunc<'a, E: Externals + 'a> {
    func_instance: &'a FuncRef,
    externals: &'a mut E,
    args: &'a [RuntimeValue],
}

impl<'a, E: Externals> BoundFunc<'a, E> {
    fn new(
        func_instance: &'a FuncRef,
        externals: &'a mut E,
        args: &'a [RuntimeValue],
    ) -> Option<BoundFunc<'a, E>> {
        check_function_args(func_instance.signature(), &args).ok()?;
        Some(BoundFunc {
            func_instance,
            externals,
            args,
        })
    }

    pub fn invoke(&mut self) -> Result<Option<RuntimeValue>, Trap> {
        FuncInstance::invoke(&self.func_instance, self.args, self.externals)
    }
}

[bddap]

I can submit a pr, just checking first to see if this is approach it useful.

[pepyakin]

Hello, @bddap ! I'm very sorry for the delay and for that I missed your comment.

Yeah, it is a good start. But we can go beyond that. For example, there is a related problem with limits (#51). And we might want to add other configuration options.

Can you see an approach that can incorporate such changes?

[Robbepop]

This issue is no longer relevant due to the fact that the current wasmi version is using Wasmtime based API which mostly is pretty well designed already.