Struct Module

pub struct Module { /* private fields */ }

A parsed and validated WebAssembly module.

Implementations

impl Module

pub fn new(engine: &Engine, wasm: impl AsRef<[u8]>) -> Result<Self, Error>

Creates a new Wasm Module from the given Wasm bytecode buffer.

Note

• This parses, validates and translates the buffered Wasm bytecode.
• The wasm may be encoded as WebAssembly binary (.wasm) or as WebAssembly text format (.wat).

Errors

• If the Wasm bytecode is malformed or fails to validate.
• If the Wasm bytecode violates restrictions set in the Config used by the engine.
• If Wasmi cannot translate the Wasm bytecode.

pub fn new_streaming(engine: &Engine, stream: impl Read) -> Result<Self, Error>

Creates a new Wasm Module from the given Wasm bytecode stream.

Note

This parses, validates and translates the Wasm bytecode yielded by stream.

Errors

• If the Wasm bytecode is malformed or fails to validate.
• If the Wasm bytecode violates restrictions set in the Config used by the engine.
• If Wasmi cannot translate the Wasm bytecode.

pub unsafe fn new_unchecked(engine: &Engine, wasm: &[u8]) -> Result<Self, Error>

Creates a new Wasm Module from the given Wasm bytecode buffer.

Note

This parses and translates the buffered Wasm bytecode.

Safety

• This does not validate the Wasm bytecode.
• It is the caller’s responsibility that the Wasm bytecode is valid.
• It is the caller’s responsibility that the Wasm bytecode adheres to the restrictions set by the used Config of the engine.
• Violating the above rules is undefined behavior.

Errors

• If the Wasm bytecode is malformed or contains invalid sections.
• If the Wasm bytecode fails to be compiled by Wasmi.

pub unsafe fn new_streaming_unchecked( engine: &Engine, stream: impl Read, ) -> Result<Self, Error>

Creates a new Wasm Module from the given byte stream.

Note

This parses and translates the Wasm bytecode yielded by stream.

Safety

• This does not validate the Wasm bytecode.
• It is the caller’s responsibility that the Wasm bytecode is valid.
• It is the caller’s responsibility that the Wasm bytecode adheres to the restrictions set by the used Config of the engine.
• Violating the above rules is undefined behavior.

Errors

• If the Wasm bytecode is malformed or contains invalid sections.
• If the Wasm bytecode fails to be compiled by Wasmi.

pub fn engine(&self) -> &Engine

Returns the Engine used during creation of the Module.

pub fn validate(engine: &Engine, wasm: &[u8]) -> Result<(), Error>

Validates wasm as a WebAssembly binary given the configuration (via Config) in engine.

This function performs Wasm validation of the binary input WebAssembly module and returns either Ok`` or Err`` depending on the results of the validation. The Config of the engine is used for Wasm validation which indicates which WebAssembly features are valid and invalid for the validation.

Note

• The input wasm must be in binary form, the text format is not accepted by this function.
• This will only validate the wasm but not try to translate it. Therefore Module::new might still fail if translation of the Wasm binary input fails to translate via the Wasmi Engine.
• Validation automatically happens as part of Module::new.

Errors

If Wasm validation for wasm fails for the given Config provided via engine.

pub fn imports(&self) -> ModuleImportsIter<'_>

Returns an iterator over the imports of the Module.

pub fn exports(&self) -> ModuleExportsIter<'_>

Returns an iterator over the exports of the Module.

pub fn get_export(&self, name: &str) -> Option<ExternType>

Looks up an export in this Module by its name.

Returns None if no export with the name was found.

Note

This function will return the type of an export with the given name.

pub fn custom_sections(&self) -> CustomSectionsIter<'_>

Returns an iterator yielding the custom sections of the Wasm Module.

Note

The returned iterator will yield no items if Config::ignore_custom_sections is set to true even if the original Wasm module contains custom sections.

Trait Implementations

impl Clone for Module

fn clone(&self) -> Module

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Module

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

Formats the value using the given formatter.