Files
wasmtime/docs/embed-rust.md
Gustav Eiman 09a091802b Update rust embed example (#967) (#968)
* Update rust embed example (#967)

Ensures that the example works with the current API.
Drops mention of HostRef as the example is complete without it.

* Cleanup
2020-02-25 09:45:21 -06:00

2.5 KiB

Embedding Wasmtime in Rust

This document shows how to embed Wasmtime using the Rust API, and run a simple wasm program.

Create some wasm

Let's create a simple WebAssembly file with a single exported function that returns an integer:

(;; wat2wasm hello.wat -o $WASM_FILES/hello.wasm ;;)
(module
  (func (export "answer") (result i32)
     i32.const 42
  )
)

Create rust project

$ cargo new --bin wasmtime_hello
$ cd wasmtime_hello
$ cp $WASM_FILES/hello.wasm .

We will be using the wasmtime engine/API to run the wasm file, so we will add the dependency to Cargo.toml:

[dependencies]
wasmtime = "<current version>"

where "" is the current version number of the wasmtime crate.

It is time to add code to the src/main.rs. First, storage needs to be activated:

use wasmtime::*;

let store = Store::default();

The hello.wasm can be read from the file system and provided to the Module object constructor as &[u8]:

use std::fs::read;

let hello_wasm = read("hello.wasm").expect("wasm file");

let module = Module::new(&store, &hello_wasm).expect("wasm module");

The module instance can now be created. Normally, you would provide exports, but in this case, there are none required:

let instance = Instance::new(&module, &[]).expect("wasm instance");

Everything is set. If a WebAssembly module has a start function -- it was run. The instance's exports can be used at this point. wasmtime provides functions to get an export by name, and ensure that it's a function:

let answer = instance.get_export("answer").expect("answer").func().expect("function");

The exported function can be called using the call method. The exported "answer" function accepts no parameters and returns a single i32 value.

let result = answer.call(&[]).expect("success");
println!("Answer: {:?}", result[0].i32());

The names of the WebAssembly module's imports and exports can be discovered by means of module's corresponding methods.

src/main.rs

use std::fs::read;
use wasmtime::*;

fn main() {
    let store = Store::default();

    let wasm = read("hello.wasm").expect("wasm file");

    let module = Module::new(&store, &wasm).expect("wasm module");
    let instance = Instance::new(&module, &[]).expect("wasm instance");

    let answer = instance.get_export("answer").expect("answer").func().expect("function");
    let result = answer.call(&[]).expect("success");
    println!("Answer: {:?}", result[0].i32());
}