Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
- API
  
  Reference documentation for the pkg.go.dev API
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

runtime

package

Go to main page

Versions in this module

v1

v1.3.2

May 22, 2026

v1.3.1

Mar 17, 2026

v1.3.0

Mar 16, 2026

Changes in this version

type File

+ AllowUnsigned bool

type FileOption

+ func WithAllowUnsigned() FileOption

+ type HostMethod interface

+ FnMethod func() (id uint32, fn CallFn)

+ type HostMethodFunc struct

+ func HostFnMethod(id uint32, fn CallFn) HostMethodFunc

+ func (f HostMethodFunc) FnMethod() (id uint32, fn CallFn)

+ type Invoker interface

+ Close func(context.Context) error

+ HasPluginMethodID func(uint32) bool

+ InvokeMethod func(context.Context, uint32, []byte) ([]byte, error)

+ InvokeMethodWithResponse func(context.Context, uint32, []byte, func([]byte) error) error

+ PluginHandshake func() (runtimecontract.Handshake, bool)

+ type LiveRuntime struct

+ func NewLive(ctx context.Context, cfg ReloadConfig, opts ...Option) (*LiveRuntime, error)

+ func (l *LiveRuntime) Close(ctx context.Context) error

+ func (l *LiveRuntime) HasPluginMethodID(methodID uint32) bool

+ func (l *LiveRuntime) InvokeMethod(ctx context.Context, methodID uint32, payload []byte) ([]byte, error)

+ func (l *LiveRuntime) InvokeMethodWithResponse(ctx context.Context, methodID uint32, payload []byte, fn func([]byte) error) error

+ func (l *LiveRuntime) PluginHandshake() (runtimecontract.Handshake, bool)

type Option

+ func WithContractSchema(schema runtimecontract.Schema) Option

+ func WithHostMethodFns(fns ...HostMethod) Option

+ type ReloadConfig struct

+ Debounce time.Duration

+ OnReload func(context.Context, Invoker, ReloadEvent) error

+ OnReloadError func(context.Context, error)

+ type ReloadEvent struct

+ Current RuntimeInfo

+ PluginPath string

+ Previous RuntimeInfo

+ Time time.Time

type Runtime

+ func (e *Runtime) ContractHasMethodID(methodID uint32) bool

+ func (e *Runtime) ContractSchema() (runtimecontract.Schema, bool)

+ func (e *Runtime) ExpectedHandshake() (runtimecontract.Handshake, bool)

+ func (e *Runtime) HasPluginCapabilities(mask uint64) bool

+ func (e *Runtime) HasPluginMethodID(methodID uint32) bool

+ func (e *Runtime) InvokeMethod(ctx context.Context, methodID uint32, payload []byte) ([]byte, error)

+ func (e *Runtime) InvokeMethodWithResponse(ctx context.Context, methodID uint32, payload []byte, fn func([]byte) error) error

+ func (e *Runtime) PluginCapabilities() uint64

+ func (e *Runtime) PluginHandshake() (runtimecontract.Handshake, bool)

+ func (e *Runtime) PluginMethodIDs() []uint32

+ func (e *Runtime) RegisterMethod(methodID uint32, fn CallFn)

+ func (e *Runtime) SupportsMethodABI() bool

+ type RuntimeInfo struct

+ ABIMajor uint16

+ ABIMinor uint16

+ Capabilities uint64

+ MethodIDs []uint32

+ SchemaHash [runtimecontract.SchemaHashLen]byte

v1.2.8

May 10, 2025

v1.2.7

May 10, 2025

v1.2.6

May 10, 2025

v1.2.5

May 10, 2025

v1.2.4

May 10, 2025

Changes in this version

+ func DefaultRuntime(ctx context.Context) (wazero.Runtime, error)

+ type CallFn func(ctx context.Context, payload []byte) ([]byte, error)

+ func Fn[In Unmarshaler, Out Marshaler](fn CallFnT[In, Out]) CallFn

+ type CallFnT func(ctx context.Context, input In) (Out, error)

+ type CallFns = map[string]CallFn

+ type DefaultHasher struct

+ func (h DefaultHasher) Hash(raw []byte) (string, error)

+ func (h DefaultHasher) IsValid(hash string, raw []byte) bool

+ type File struct

+ Hash string

+ Name string

+ Path string

+ func NewFile(path string, opts ...FileOption) (*File, error)

+ func (f *File) GetData() ([]byte, error)

+ func (f *File) Verify() (*File, error)

+ type FileOption func(*File)

+ func WithHash(hash string) FileOption

+ func WithHasher(hasher Hasher) FileOption

+ type Hasher interface

+ Hash func(data []byte) (string, error)

+ IsValid func(hash string, data []byte) bool

+ type HostFunc interface

+ Fn func() (name string, fn CallFn)

+ type HostFuncByte struct

+ func HostFnByte(name string, fn CallFn) *HostFuncByte

+ func (f HostFuncByte) Fn() (name string, fn CallFn)

+ type HostFunction struct

+ func HostFnSerial[In Unmarshaler, Out Marshaler](name string, fn CallFnT[In, Out]) *HostFunction[In, Out]

+ func (f *HostFunction[In, Out]) Fn() (name string, fn CallFn)

+ type Marshaler interface

+ MarshalMsg func([]byte) ([]byte, error)

+ type NewRuntime func(context.Context) (wazero.Runtime, error)

+ type Option func(*Runtime) error

+ func WithCallHandler(callHandler module.CallHandler) Option

+ func WithFile(file string, opts ...FileOption) Option

+ func WithHostFns(fns ...HostFunc) Option

+ func WithLogger(logger logger.Logger) Option

+ func WithRandSource(rand io.Reader) Option

+ func WithStderr(stderr io.Writer) Option

+ func WithStdout(stdout io.Writer) Option

+ type PluginFunc interface

+ Call func(ctx context.Context, input In) (Out, error)

+ type PluginFuncByte struct

+ Name string

+ func PluginFnByte(rt *Runtime, name string) (*PluginFuncByte, error)

+ func (p PluginFuncByte) Call(ctx context.Context, input []byte) ([]byte, error)

+ type PluginFuncSerial struct

+ Name string

+ func PluginFnSerial[In Marshaler, Out Unmarshaler](rt *Runtime, name string) (*PluginFuncSerial[In, Out], error)

+ func (p *PluginFuncSerial[In, Out]) Call(ctx context.Context, input In) (Out, error)

+ type Runtime struct

+ func New(ctx context.Context, opts ...Option) (*Runtime, error)

+ func (e *Runtime) Close(ctx context.Context) error

+ func (e *Runtime) Compile() error

+ func (e *Runtime) Init() error

+ func (e *Runtime) InitConfig()

+ func (e *Runtime) InitHookr() error

+ func (e *Runtime) InitRuntime() error

+ func (e *Runtime) Instantiate() error

+ func (e *Runtime) Invoke(ctx context.Context, operation string, payload []byte) ([]byte, error)

+ func (e *Runtime) MemorySize() uint32

+ func (e *Runtime) RegisterFunction(name string, fn CallFn)

+ type Sha256Hasher struct

+ func (h Sha256Hasher) Hash(data []byte) (string, error)

+ func (h Sha256Hasher) IsValid(hash string, data []byte) bool

+ type Unmarshaler interface

+ UnmarshalMsg func([]byte) ([]byte, error)

v1.2.3

May 10, 2025

v1.2.2

May 10, 2025

v1.2.1

Apr 25, 2025

v1.2.0

Apr 25, 2025