Struct sc_executor_common::sandbox::SandboxInstance

pub struct SandboxInstance<FR> { /* fields omitted */ }

Sandboxed instance of a wasm module.

It's primary purpose is to invoke exported functions on it.

All imports of this instance are specified at the creation time and imports are implemented by the supervisor.

Hence, in order to invoke an exported function on a sandboxed module instance, it's required to provide supervisor externals: it will be used to execute code in the supervisor context.

This is generic over a supervisor function reference type.

Methods

impl<FR> SandboxInstance<FR>

pub fn invoke<FE: SandboxCapabilities<SupervisorFuncRef = FR>>(
    &self,
    export_name: &str,
    args: &[RuntimeValue],
    supervisor_externals: &mut FE,
    state: u32
) -> Result<Option<RuntimeValue>, Error>

Invoke an exported function by a name.

supervisor_externals is required to execute the implementations of the syscalls that published to a sandboxed module instance.

The state parameter can be used to provide custom data for these syscall implementations.

pub fn get_global_val(&self, name: &str) -> Option<Value>

Get the value from a global with the given name.

Returns Some(_) if the global could be found.