Struct patract_wasmi::NotStartedModuleRef

pub struct NotStartedModuleRef<'a> { /* fields omitted */ }

Mostly instantiated ModuleRef.

At this point memory segments and tables are copied. However, start function (if any) is not called. To get fully instantiated module instance, running start function is required.

You can still access not fully initialized instance by calling not_started_instance, but keep in mind, that this is sort of escape hatch: module really might depend on initialization done in start function. It’s definitely not recommended to call any exports on ModuleRef returned by this function.

If you sure, that there is no start function (e.g. because you created it without one), you can call assert_no_start which returns ModuleRef without calling start function. However, it will panic if module contains start function.

Implementations

impl<'a> NotStartedModuleRef<'a>

pub fn not_started_instance(&self) -> &ModuleRef

Returns not fully initialized instance.

To fully initialize the instance you need to call either run_start or assert_no_start. See struct documentation for details.

pub fn run_start<E: Externals>(self, state: &mut E) -> Result<ModuleRef, Trap>

Executes start function (if any) and returns fully instantiated module.

Errors

Returns Err if start function traps.

pub fn run_start_with_stack<E: Externals>(
    self,
    state: &mut E,
    stack_recycler: &mut StackRecycler
) -> Result<ModuleRef, Trap>

Executes start function (if any) and returns fully instantiated module.

Errors

Returns Err if start function traps.

pub fn assert_no_start(self) -> ModuleRef

Returns fully instantiated module without running start function.

Panics

This function panics if original module contains start function.

pub fn has_start(&self) -> bool

Whether or not the module has a start function.

Returns true if it has a start function.