# [−] [src] Struct wasmi::ModuleRef

    pub struct ModuleRef(_);

Reference to a `ModuleInstance`.

This reference has a reference-counting semantics.

All `ModuleInstance` have strong references to it's components (i.e. globals, memories, funcs, tables), however, this components have weak references to it's containing module. This might be a problem at execution time.

So if have to make sure that all modules which might be needed at execution time should be retained.

## Methods from Deref<Target = ModuleInstance>

#### `pub fn globals<'a>(&self) -> Ref<Vec<GlobalRef>>` [src]

Access all globals. This is a non-standard API so it's unlikely to be portable to other engines.

#### `pub fn invoke_export<E: Externals>(
&self,
func_name: &str,
args: &[RuntimeValue],
externals: &mut E
) -> Result<Option<RuntimeValue>, Error>` [src]

Invoke exported function by a name.

This function finds exported function by a name, and calls it with provided arguments and external state.

# Errors

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 occurred at the execution time,

# Examples

Invoke a function that takes two numbers and returns sum of them.

    assert_eq!(
        instance.invoke_export(
            "add",
            &[RuntimeValue::I32(5), RuntimeValue::I32(3)],
            &mut NopExternals,
        ).expect("failed to execute export"),
        Some(RuntimeValue::I32(8)),
    );

#### `pub fn invoke_export_with_stack<E: Externals>(
&self,
func_name: &str,
args: &[RuntimeValue],
externals: &mut E,
stack_recycler: &mut StackRecycler
) -> Result<Option<RuntimeValue>, Error>` [src]

Invoke exported function by a name using recycled stacks.

# Errors

Same as `invoke_export`.

#### `pub fn export_by_name(&self, name: &str) -> Option<ExternVal>` [src]

Find export by a name.

Returns `None` if there is no export with such name.

## Trait Implementations

### `impl ModuleImportResolver for ModuleRef` [src]

#### `fn resolve_func(
&self,
field_name: &str,
_signature: &Signature
) -> Result<FuncRef, Error>` [src]

Resolve a function. Read more

#### `fn resolve_global(
&self,
field_name: &str,
_global_type: &GlobalDescriptor
) -> Result<GlobalRef, Error>` [src]

Resolve a global variable. Read more

#### `fn resolve_memory(
&self,
field_name: &str,
_memory_type: &MemoryDescriptor
) -> Result<MemoryRef, Error>` [src]

Resolve a memory. Read more

#### `fn resolve_table(
&self,
field_name: &str,
_table_type: &TableDescriptor
) -> Result<TableRef, Error>` [src]

Resolve a table. Read more

### `impl Clone for ModuleRef` [src]

#### `fn clone(&self) -> ModuleRef` [src]

Returns a copy of the value. Read more

#### `fn clone_from(&mut self, source: &Self)`1.0.0 [src]

Performs copy-assignment from `source`. Read more

### `impl Debug for ModuleRef` [src]

#### `fn fmt(&self, f: &mut Formatter) -> Result` [src]

Formats the value using the given formatter. Read more

### `impl Deref for ModuleRef` [src]

#### `type Target = ModuleInstance`

The resulting type after dereferencing.

#### `fn deref(&self) -> &ModuleInstance` [src]

Dereferences the value.

## Auto Trait Implementations

### `impl !Send for ModuleRef`

### `impl !Sync for ModuleRef`

### `impl Unpin for ModuleRef`

### `impl !UnwindSafe for ModuleRef`

### `impl !RefUnwindSafe for ModuleRef`

## Blanket Implementations

### `impl<T, U> Into<U> for T where
U: From<T>,` [src]

#### `fn into(self) -> U` [src]

Performs the conversion.

### `impl<T> From<T> for T` [src]

#### `fn from(t: T) -> T` [src]

Performs the conversion.

### `impl<T> ToOwned for T where
T: Clone,` [src]

#### `type Owned = T`

The resulting type after obtaining ownership.

#### `fn to_owned(&self) -> T` [src]

Creates owned data from borrowed data, usually by cloning. Read more

#### `fn clone_into(&self, target: &mut T)` [src]

🔬 This is a nightly-only experimental API. (`toowned_clone_into`)

recently added

Uses borrowed data to replace owned data, usually by cloning. Read more

### `impl<T, U> TryFrom<U> for T where
U: Into<T>,` [src]

#### `type Error = Infallible`

The type returned in the event of a conversion error.

#### `fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>` [src]

Performs the conversion.

### `impl<T, U> TryInto<U> for T where
U: TryFrom<T>,` [src]

#### `type Error = <U as TryFrom<T>>::Error`

The type returned in the event of a conversion error.

#### `fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>` [src]

Performs the conversion.

### `impl<T> Borrow<T> for T where
T: ?Sized,` [src]

#### `fn borrow(&self) -> &T` [src]

Immutably borrows from an owned value. Read more

### `impl<T> BorrowMut<T> for T where
T: ?Sized,` [src]

#### `fn borrow_mut(&mut self) -> &mut T` [src]

Mutably borrows from an owned value. Read more

### `impl<T> Any for T where
T: 'static + ?Sized,` [src]

#### `fn type_id(&self) -> TypeId` [src]

Gets the `TypeId` of `self`. Read more

# Help

## Keyboard Shortcuts

`?`
  Show this help dialog
`S`
  Focus the search field
`↑`
  Move up in search results
`↓`
  Move down in search results
`↹`
  Switch tab
`⏎`
  Go to active search result
`+`
  Expand all sections
`-`
  Collapse all sections

## Search Tricks

Prefix searches with a type followed by a colon (e.g., `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct`, `enum`, `trait`, `type`, `macro`, and `const`.

Search functions by type signature (e.g., `vec -> usize` or `* -> vec`)

Search multiple things at once by splitting your query with comma (e.g., `str,u8` or `String,struct:Vec,test`)