plugins

Documentation

Index

• Constants
• func FromMap[T any](m map[string]any) (T, error)
• type Dispatcher
• type Error
  • func NewError(what string, err error) *Error
  • func (r Error) Error() string
• type Heartbeater
• type Server
  • func NewServer[Q Heartbeater[R], R any](call func(Dispatcher, Q) R) (*Server[Q, R], error)

Constants

const StatusInfoLog = 101

StatusInfoLog is used to mark a INFO log message from the server.

Functions

func FromMap

func FromMap[T any](m map[string]any) (T, error)

FromNMap converts m to T. See https://pkg.go.dev/github.com/mitchellh/mapstructure#section-readme

Types

type Dispatcher

type Dispatcher interface {
	Infof(format string, args ...interface{})
}

type Error

type Error struct {
	Msg string `toml:"msg"`
}

Error holds an error message.

func NewError

func NewError(what string, err error) *Error

Error is an error that can be returned from a plugin, it's main quality is that it can be marshalled to and from TOML/JSON etc.

func (Error) Error

func (r Error) Error() string

type Heartbeater

type Heartbeater[R any] interface {
	HeartbeatResponse() (R, bool)
}

type Server

type Server[Q, R any] struct {
	*execrpc.Server[Q, R]
}

func NewServer

func NewServer[Q Heartbeater[R], R any](call func(Dispatcher, Q) R) (*Server[Q, R], error)

NewServer creates a new server which will call the given function with a request Q. The Dispatcher an be used for logging. Any errors needs to be sent in R.