wasmdebug

Documentation

Overview

Package wasmdebug contains utilities used to give consistent search keys between stack traces and error messages. Note: This is named wasmdebug to avoid conflicts with the normal go module. Note: This only imports "api" as importing "wasm" would create a cyclic dependency.

Index

• func FuncName(moduleName, funcName string, funcIdx uint32) string
• type ErrorBuilder
  • func NewErrorBuilder() ErrorBuilder

Functions

func FuncName

func FuncName(moduleName, funcName string, funcIdx uint32) string

FuncName returns the naming convention of "moduleName.funcName".

* moduleName is the possibly empty name the module was instantiated with. * funcName is the name in the Custom Name section, an export name, or what the host defines. * funcIdx is the position in the function index namespace, prefixed with imported functions.

Note: "moduleName.[funcIdx]" is used when the funcName is empty, as commonly the case in TinyGo.

Types

type ErrorBuilder

type ErrorBuilder interface {
	// AddFrame adds the next frame.
	//
	// * funcName should be from FuncName
	// * paramTypes should be from wasm.FunctionType
	// * resultTypes should be from wasm.FunctionType
	//
	// Note: paramTypes and resultTypes are present because signature misunderstanding, mismatch or overflow are common.
	AddFrame(funcName string, paramTypes, resultTypes []api.ValueType)

	// FromRecovered returns an error with the wasm stack trace appended to it.
	FromRecovered(recovered interface{}) error
}

ErrorBuilder helps build consistent errors, particularly adding a WASM stack trace.

AddFrame should be called beginning at the frame that panicked until no more frames exist. Once done, call Format.

func NewErrorBuilder

func NewErrorBuilder() ErrorBuilder