Struct wasmer::Exports

pub struct Exports { /* fields omitted */ }

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_native_function<Args, Rets>(
    &self,
    name: &str
) -> Result<NativeFunc<Args, Rets>, ExportError> where
    Args: WasmTypeList,
    Rets: WasmTypeList, 

Get an export as a NativeFunc.

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_with_generics_weak<'a, T, Args, Rets>(
    &'a self,
    name: &str
) -> Result<T, ExportError> where
    Args: WasmTypeList,
    Rets: WasmTypeList,
    T: ExportableWithGenerics<'a, Args, Rets>, 

Like get_with_generics but with a WeakReference to the InstanceRef internally. This is useful for passing data into WasmerEnv, for example.

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 LikeNamespace for Exports

fn get_namespace_export(&self, name: &str) -> Option<Export>

Gets an export by name.

fn get_namespace_exports(&self) -> Vec<(String, Export)>

Gets all exports in the namespace.

impl MemoryUsage for Exports

fn size_of_val(&self, visited: &mut dyn MemoryUsageTracker) -> usize

Returns the size of the referenced value in bytes.