Struct Exports

pub struct Exports { /* private fields */ }

Exports is a special kind of map that allows easily unwrapping the types of instances.

TODO: add examples of using exports

Implementations

impl Exports

pub fn new() -> Self

Creates a new Exports.

pub fn with_capacity(n: usize) -> Self

Creates a new Exports with capacity n.

pub fn len(&self) -> usize

Return the number of exports in the Exports map.

pub fn is_empty(&self) -> bool

Return whether or not there are no exports

pub fn insert<S, E>(&mut self, name: S, value: E)

where S: Into<String>, E: Into<Extern>,

Insert a new export into this Exports map.

pub fn get<'a, T: Exportable<'a>>( &'a self, name: &str, ) -> Result<&'a T, ExportError>

Get an export given a name.

The get method is specifically made for usage inside of Rust APIs, as we can detect what’s the desired type easily.

If you want to get an export dynamically with type checking please use the following functions: get_func, get_memory, get_table or get_global instead.

If you want to get an export dynamically handling manually type checking manually, please use get_extern.

pub fn get_global(&self, name: &str) -> Result<&Global, ExportError>

Get an export as a Global.

pub fn get_memory(&self, name: &str) -> Result<&Memory, ExportError>

Get an export as a Memory.

pub fn get_table(&self, name: &str) -> Result<&Table, ExportError>

Get an export as a Table.

pub fn get_function(&self, name: &str) -> Result<&Function, ExportError>

Get an export as a Func.

pub fn get_typed_function<Args, Rets>( &self, store: &impl AsStoreRef, name: &str, ) -> Result<TypedFunction<Args, Rets>, ExportError>

where Args: WasmTypeList, Rets: WasmTypeList,

Get an export as a TypedFunction.

pub fn get_with_generics<'a, T, Args, Rets>( &'a self, name: &str, ) -> Result<T, ExportError>

where Args: WasmTypeList, Rets: WasmTypeList, T: ExportableWithGenerics<'a, Args, Rets>,

Hack to get this working with nativefunc too

pub fn get_extern(&self, name: &str) -> Option<&Extern>

Get an export as an Extern.

pub fn contains<S>(&self, name: S) -> bool

where S: Into<String>,

Returns true if the Exports contains the given export name.

pub fn iter( &self, ) -> ExportsIterator<'_, impl Iterator<Item = (&String, &Extern)>>

Get an iterator over the exports.

Trait Implementations

impl Clone for Exports

fn clone(&self) -> Exports

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Exports

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Exports

fn default() -> Exports

Returns the “default value” for a type.

impl FromIterator<(String, Extern)> for Exports

fn from_iter<I: IntoIterator<Item = (String, Extern)>>(iter: I) -> Self

Creates a value from an iterator.

impl<'a> IntoIterator for &'a Exports

type IntoIter = Iter<'a, String, Extern>

Which kind of iterator are we turning this into?

type Item = (&'a String, &'a Extern)

The type of the elements being iterated over.

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl IntoIterator for Exports

type IntoIter = IntoIter<String, Extern>

Which kind of iterator are we turning this into?

type Item = (String, Extern)

The type of the elements being iterated over.

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl PartialEq for Exports

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Exports

impl StructuralPartialEq for Exports