plugin

Documentation

Index

• func PrefixMessage(pluginInfo api.Info, message string) string
• func Serve(pluginServer api.PluginServer, serviceServers ...api.ServiceServer)
• func ServeOptions(options ...pluginoption.ServerOption) error
• type Facade
  • func FixedFacade(pluginName, pluginType string, log *slog.Logger) Facade
  • func (f *Facade) Error(code codes.Code, message string) error
  • func (f *Facade) Errorf(code codes.Code, format string, args ...any) error
  • func (f *Facade) InitInfo(pluginInfo api.Info)
  • func (f *Facade) InitLog(log *slog.Logger)
  • func (f *Facade) WrapErr(err error) error

Functions

func PrefixMessage

func PrefixMessage(pluginInfo api.Info, message string) string

PrefixMessage prefixes the given message with plugin information. The prefix is only applied if it is not already applied.

func Serve

func Serve(pluginServer api.PluginServer, serviceServers ...api.ServiceServer)

func ServeOptions

func ServeOptions(options ...pluginoption.ServerOption) error

Types

type Facade

type Facade struct {
	api.Info
	Log *slog.Logger
}

Facade is embedded by plugin interface facade implementations as a convenient way to embed Info but also provide a set of convenient functions for embellishing and generating errors that have the plugin name prefixed.

func FixedFacade

func FixedFacade(pluginName, pluginType string, log *slog.Logger) Facade

FixedFacade is a helper that creates a facade from fixed information, i.e. not the product of a loaded plugin.

func (*Facade) Error

func (f *Facade) Error(code codes.Code, message string) error

Error creates a gRPC status with the given code and message. The message will be prefixed with the plugin name.

func (*Facade) Errorf

func (f *Facade) Errorf(code codes.Code, format string, args ...any) error

Errorf creates a gRPC status with the given code and formatted message. The message will be prefixed with the plugin name.

func (*Facade) InitInfo

func (f *Facade) InitInfo(pluginInfo api.Info)

InitInfo partially satisfies the catalog.Facade interface

func (*Facade) InitLog

func (f *Facade) InitLog(log *slog.Logger)

InitLog partially satisfies the catalog.Facade interface

func (*Facade) WrapErr

func (f *Facade) WrapErr(err error) error

WrapErr wraps a given error such that it will be prefixed with the plugin name. This method should be used by facade implementations to wrap errors that come out of plugin implementations.