Files
wasmtime/crates/misc/rust
Alex Crichton e5afdd2ede Document the wasmtime::Instance APIs (#814)
* Document the `wasmtime::Instance` APIs

This documents oddities like the import list and export list and how to
match them all up. Addtionally this largely just expands all the docs
related to `Instance` to get filled out.

This also moves the `set_signal_handler` functions into
platform-specific modules in order to follow Rust idioms about how to
expose platform-specific information. Additionally the methods are
marked `unsafe` because I figure anything having to do with signal
handling is `unsafe` inherently. I don't actually know what these
functions do, so they're currently still undocumented.

* Fix build of python bindings

* Fix some rebase conflicts
2020-01-16 17:58:44 -06:00
..
2019-11-08 06:35:40 -08:00
2020-01-09 21:57:40 -08:00
2019-11-08 06:35:40 -08:00

wasmtime-rust - Using WebAssembly from Rust

This crate is intended to be an example of how to load WebAssembly files from a native Rust application. You can always use wasmtime and its family of crates directly, but the purpose of this crate is to provide an ergonomic macro:

#[wasmtime_rust::wasmtime]
trait WasmMarkdown {
    fn render(&mut self, input: &str) -> String;
}

fn main() -> anyhow::Result<()> {
    let mut markdown = WasmMarkdown::load_file("markdown.wasm")?;
    println!("{}", markdown.render("# Hello, Rust!"));

    Ok(())
}

The wasmtime macro defined in the wasmtime-rust crate is placed on a trait which includes the set of functionality which a wasm module should export. In this case we're expecting one render function which takes and returns a string.

The macro expands to a struct with all of the methods on the trait (they must all be &mut self) and one function called load_file to actually instantiate the module.

Note that this macro is still in early stages of development, so error messages aren't great yet and all functionality isn't supported yet.

Missing features

Currently if the wasm module imports any symbols outside of the WASI namespace the module will not load. It's intended that support for this will be added soon though!