runtime

Documentation

Overview

Package runtime implements the Scale Runtime in Go.

Index

• Variables
• type Function
  • func (f *Function[T]) Run(ctx context.Context, i *Instance[T]) error
• type Instance
  • func (i *Instance[T]) Context() T
  • func (i *Instance[T]) Run(ctx context.Context) error
• type Module
  • func NewModule[T signature.Signature](ctx context.Context, f *Function[T], r *Runtime[T]) (*Module[T], error)
• type NewSignature
• type Next
• type Pool
  • func NewPool[T signature.Signature](ctx context.Context, f *Function[T], r *Runtime[T]) *Pool[T]
  • func (p *Pool[T]) Get() (*Module[T], error)
  • func (p *Pool[T]) Put(module *Module[T])
• type Runtime
  • func New[T signature.Signature](ctx context.Context, sig NewSignature[T], functions []*scalefunc.ScaleFunc) (*Runtime[T], error)
  • func (r *Runtime[T]) Instance(next ...Next[T]) (*Instance[T], error)

Variables

var (
	NoFunctionsError = errors.New("no functions found in runtime")
)

Types

type Function

type Function[T signature.Signature] struct {
	// contains filtered or unexported fields
}

Function is the runtime representation of a scale function.

func (*Function[T]) Run

func (f *Function[T]) Run(ctx context.Context, i *Instance[T]) error

type Instance

type Instance[T signature.Signature] struct {
	// contains filtered or unexported fields
}

func (*Instance[T]) Context

func (i *Instance[T]) Context() T

func (*Instance[T]) Run

func (i *Instance[T]) Run(ctx context.Context) error

type Module

type Module[T signature.Signature] struct {
	// contains filtered or unexported fields
}

func NewModule

func NewModule[T signature.Signature](ctx context.Context, f *Function[T], r *Runtime[T]) (*Module[T], error)

type NewSignature

type NewSignature[T signature.Signature] func() T

NewSignature is a factory function for creating a new signature.Signature.

type Next

type Next[T signature.Signature] func(ctx T) (T, error)

Next is the next function in the middleware chain. It's meant to be implemented by whatever adapter is being used.

type Pool

type Pool[T signature.Signature] struct {
	// contains filtered or unexported fields
}

func NewPool

func NewPool[T signature.Signature](ctx context.Context, f *Function[T], r *Runtime[T]) *Pool[T]

func (*Pool[T]) Get

func (p *Pool[T]) Get() (*Module[T], error)

func (*Pool[T]) Put

func (p *Pool[T]) Put(module *Module[T])

type Runtime

type Runtime[T signature.Signature] struct {
	// contains filtered or unexported fields
}

Runtime is the Scale Runtime. It is responsible for initializing and managing the WASM runtime as well as the scale function chain.

func New

func New[T signature.Signature](ctx context.Context, sig NewSignature[T], functions []*scalefunc.ScaleFunc) (*Runtime[T], error)

func (*Runtime[T]) Instance

func (r *Runtime[T]) Instance(next ...Next[T]) (*Instance[T], error)