Struct wasmtime_runtime::InstanceHandle

pub struct InstanceHandle { /* fields omitted */ }

A handle holding an Instance of a WebAssembly module.

Methods

impl InstanceHandle

pub fn new(
    module: Rc<Module>,
    global_exports: Rc<RefCell<HashMap<String, Option<Export>>>>,
    finished_functions: BoxedSlice<DefinedFuncIndex, *const VMFunctionBody>,
    imports: Imports,
    data_initializers: &[DataInitializer],
    vmshared_signatures: BoxedSlice<SignatureIndex, VMSharedSignatureIndex>,
    dbg_jit_registration: Option<Rc<GdbJitImageRegistration>>,
    host_state: Box<dyn Any>
) -> Result<Self, InstantiationError>

Create a new InstanceHandle pointing at a new Instance.

pub unsafe fn from_vmctx(vmctx: *mut VMContext) -> Self

Create a new InstanceHandle pointing at the instance pointed to by the given VMContext pointer.

pub fn vmctx(&self) -> &VMContext

Return a reference to the vmctx used by compiled wasm code.

pub fn vmctx_ptr(&self) -> *const VMContext

Return a raw pointer to the vmctx used by compiled wasm code.

pub fn module(&self) -> Rc<Module>

Return a reference-counting pointer to a module.

pub fn module_ref(&self) -> &Module

Return a reference to a module.

pub fn vmctx_mut(&mut self) -> &mut VMContext

Return a mutable reference to the vmctx used by compiled wasm code.

pub fn vmctx_mut_ptr(&mut self) -> *mut VMContext

Return a mutable raw pointer to the vmctx used by compiled wasm code.

pub fn lookup(&mut self, field: &str) -> Option<Export>

Lookup an export with the given name.

pub unsafe fn lookup_immutable(&self, field: &str) -> Option<Export>

Lookup an export with the given name. This takes an immutable reference, and the result is an Export that the type system doesn't prevent from being used to mutate the instance, so this function is unsafe.

pub fn lookup_by_declaration(&mut self, export: &Export) -> Export

Lookup an export with the given export declaration.

pub unsafe fn lookup_immutable_by_declaration(&self, export: &Export) -> Export

Lookup an export with the given export declaration. This takes an immutable reference, and the result is an Export that the type system doesn't prevent from being used to mutate the instance, so this function is unsafe.

pub fn exports(&self) -> Iter<String, Export>

Return an iterator over the exports of this instance.

Specifically, it provides access to the key-value pairs, where they keys are export names, and the values are export declarations which can be resolved lookup_by_declaration.

pub fn host_state(&mut self) -> &mut dyn Any

Return a reference to the custom state attached to this instance.

pub fn memory_index(&self, memory: &VMMemoryDefinition) -> DefinedMemoryIndex

Return the memory index for the given VMMemoryDefinition in this instance.

pub fn memory_grow(
    &mut self,
    memory_index: DefinedMemoryIndex,
    delta: u32
) -> Option<u32>

Grow memory in this instance by the specified amount of pages.

Returns None if memory can't be grown by the specified amount of pages.

pub fn table_index(&self, table: &VMTableDefinition) -> DefinedTableIndex

Return the table index for the given VMTableDefinition in this instance.

pub fn table_grow(
    &mut self,
    table_index: DefinedTableIndex,
    delta: u32
) -> Option<u32>

Grow table in this instance by the specified amount of pages.

Returns None if memory can't be grown by the specified amount of pages.

pub fn table_get(
    &self,
    table_index: DefinedTableIndex,
    index: u32
) -> Option<&VMCallerCheckedAnyfunc>

Get table element reference.

Returns None if index is out of bounds.

pub fn table_get_mut(
    &mut self,
    table_index: DefinedTableIndex,
    index: u32
) -> Option<&mut VMCallerCheckedAnyfunc>

Get mutable table element reference.

Returns None if index is out of bounds.

Trait Implementations

impl Drop for InstanceHandle

fn drop(&mut self)

Executes the destructor for this type.

impl Clone for InstanceHandle

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Eq for InstanceHandle

impl PartialEq<InstanceHandle> for InstanceHandle

fn eq(&self, other: &InstanceHandle) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &InstanceHandle) -> bool

This method tests for !=.

impl Hash for InstanceHandle

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl StructuralPartialEq for InstanceHandle

impl StructuralEq for InstanceHandle