This renames `InstantiateModuleFromBinary` to `Instantiate` to both make first time use simpler to write and also de-complicate adding a `WithConfig` variant as requested in #1105 End users in simple case need to change their signature like so. ```diff - mod, err := r.InstantiateModuleFromBinary(ctx, addWasm) + mod, err := r.Instantiate(ctx, addWasm) ``` In practice, many will not need to change their signature because they had to use the `InstantiateModule` function in order to assign configuration such as the module name, filesystem or use a real clock. Instead, they had to use the more complicated chain of `CompileModule` and `InstantiateModule` even when only assigning config. Users in this situation can opt into the more simplified syntax below: ```go mod, err := r.InstantiateWithConfig(ctx, addWasm, wazero.NewModuleConfig().WithName("adder")) ``` ```diff - mod, err := r.InstantiateModuleFromBinary(ctx, addWasm) + mod, err := r.Instantiate(ctx, addWasm) ``` Signed-off-by: Adrian Cole <adrian@tetrate.io>
59 lines
1.5 KiB
Go
59 lines
1.5 KiB
Go
package wazero_test
|
|
|
|
import (
|
|
"context"
|
|
_ "embed"
|
|
"fmt"
|
|
"log"
|
|
|
|
"github.com/tetratelabs/wazero"
|
|
"github.com/tetratelabs/wazero/imports/wasi_snapshot_preview1"
|
|
)
|
|
|
|
// addWasm was generated by the following:
|
|
//
|
|
// cd examples/basic/testdata; tinygo build -o add.wasm -target=wasi add.go
|
|
//
|
|
//go:embed examples/basic/testdata/add.wasm
|
|
var addWasm []byte
|
|
|
|
// This is an example of how to extend a Go application with an addition
|
|
// function defined in WebAssembly.
|
|
//
|
|
// Since addWasm was compiled with TinyGo's `wasi` target, we need to configure
|
|
// WASI host imports.
|
|
//
|
|
// A complete project that does the same as this is available here:
|
|
// https://github.com/tetratelabs/wazero/tree/main/examples/basic
|
|
func Example() {
|
|
// Choose the context to use for function calls.
|
|
ctx := context.Background()
|
|
|
|
// Create a new WebAssembly Runtime.
|
|
r := wazero.NewRuntime(ctx)
|
|
defer r.Close(ctx) // This closes everything this Runtime created.
|
|
|
|
// Instantiate WASI, which implements host functions needed for TinyGo to
|
|
// implement `panic`.
|
|
wasi_snapshot_preview1.MustInstantiate(ctx, r)
|
|
|
|
// Instantiate the guest Wasm into the same runtime. It exports the `add`
|
|
// function, implemented in WebAssembly.
|
|
mod, err := r.Instantiate(ctx, addWasm)
|
|
if err != nil {
|
|
log.Panicln(err)
|
|
}
|
|
|
|
// Call the `add` function and print the results to the console.
|
|
x, y := uint64(1), uint64(2)
|
|
results, err := mod.ExportedFunction("add").Call(ctx, x, y)
|
|
if err != nil {
|
|
log.Panicln(err)
|
|
}
|
|
|
|
fmt.Printf("%d + %d = %d\n", x, y, results[0])
|
|
|
|
// Output:
|
|
// 1 + 2 = 3
|
|
}
|