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

plugin

package module

Go to main page

Versions in this module

v0

v0.20.10

Nov 3, 2026

v0.20.9

Nov 3, 2026

v0.20.8

Nov 2, 2026

v0.20.7

Oct 30, 2026

v0.20.6

Oct 29, 2026

v0.20.5

Oct 21, 2026

v0.20.4

Oct 20, 2026

v0.20.3

Oct 14, 2026

v0.20.2

Oct 14, 2026

v0.20.1

Oct 13, 2026

v0.20.0

Sep 29, 2026

v0.19.3

Sep 1, 2026

v0.19.2

Aug 26, 2026

Changes in this version

+ var ErrHostClosed = errors.New("plugin host is closed")

v0.19.1

Aug 21, 2026

v0.19.0

Aug 21, 2026

Changes in this version

+ const MaxMessageSize

+ const MaxValueDepth

+ const PluginName

+ const ProtocolVersion

+ var ErrAppAlreadyInited = errors.New("app already initialized in this provider process")

+ var ErrAppNotInited = errors.New("app not initialized")

+ var ErrModuleNotInited = errors.New("module not initialized")

+ var ErrUnknownFunction = errors.New("unknown function")

+ var ErrUnknownModule = errors.New("unknown module")

+ var Handshake = goplugin.HandshakeConfig

+ func DecodeValue(v *pb.StarValue) (any, error)

+ func DecodeValueMap(m map[string]*pb.StarValue) (map[string]any, error)

+ func EmbeddedProviders() map[string]*ServeConfig

+ func EncodeValue(v any) (*pb.StarValue, error)

+ func EncodeValueMap(m map[string]any) (map[string]*pb.StarValue, error)

+ func ErrorWithCode(code int64, err error) error

+ func RegisterEmbedded(name string, config *ServeConfig)

+ func Serve(config *ServeConfig)

+ func UnpackArgs(fnName string, call *Call, pairs ...any) error

+ type AppInfo struct

+ AppId string

+ AppPath string

+ AppSchema []byte

+ IsDev bool

+ type Call struct

+ Args []any

+ Function string

+ Host HostServices

+ Kwargs []Kwarg

+ Session *Session

+ Thread ThreadState

+ type Client struct

+ type Cursor struct

+ Close func(ctx context.Context) error

+ LeakKey string

+ Next func(ctx context.Context, max int) ([]any, bool, error)

+ Stream bool

+ TypeName string

+ func PushCursor(typeName, leakKey string, stream bool, seq func(yield func(any, error) bool)) *Cursor

+ type CursorInfo struct

+ CursorId string

+ LeakKey string

+ Stream bool

+ TypeName string

+ type Dict struct

+ Entries []DictEntry

+ type DictEntry struct

+ Key any

+ Value any

+ type Download struct

+ Name string

+ Producer func(w io.Writer) error

+ type Func = func(ctx context.Context, call *Call) (any, error)

+ type FuncDef struct

+ Method string

+ Name string

+ Type FunctionType

+ type FuncRef struct

+ Args []any

+ Function string

+ type FunctionType int

+ const READ

+ const WRITE

+ type Host struct

+ func NewHost(config *ServeConfig, logger *Logger) (*Host, error)

+ func (h *Host) Call(ctx context.Context, call *HostCall) (*HostResult, error)

+ func (h *Host) Close(ctx context.Context)

+ func (h *Host) Config() *ServeConfig

+ func (h *Host) CursorClose(ctx context.Context, sessionId, cursorId string) error

+ func (h *Host) CursorNext(ctx context.Context, sessionId, cursorId string, max int) ([]any, bool, error)

+ func (h *Host) DetachCursor(sessionId, cursorId string) (*Cursor, error)

+ func (h *Host) EndSession(ctx context.Context, sessionId string) error

+ func (h *Host) InitApp(info AppInfo) error

+ func (h *Host) InitModule(ctx context.Context, module, account string, settings map[string]any) error

+ func (h *Host) Retire()

+ func (h *Host) StartSession(sessionId string)

+ type HostCall struct

+ Account string

+ Args []any

+ Function string

+ Host HostServices

+ Kwargs []Kwarg

+ Module string

+ SessionId string

+ Thread ThreadState

+ type HostResult struct

+ Cursor *CursorInfo

+ StrictKeys []string

+ Value any

+ type HostServices interface

+ Value func(key string) any

+ type Kwarg struct

+ Name string

+ Value any

+ type LaunchConfig struct

+ ExecPath string

+ LogLevel string

+ Logger hclog.Logger

+ SecureConfig *goplugin.SecureConfig

+ type Logger struct

+ func NewLogger(level string) *Logger

+ type Module interface

+ Close func(ctx context.Context) error

+ InitModule func(ctx context.Context, init ModuleInit) error

+ type ModuleDef struct

+ Builder func() Module

+ Constants map[string]any

+ Functions []FuncDef

+ type ModuleInit struct

+ Account string

+ AppId string

+ AppPath string

+ AppSchema []byte

+ IsDev bool

+ Logger *Logger

+ Settings map[string]any

+ type Provider struct

+ func LaunchProvider(config LaunchConfig) (*Provider, error)

+ func (p *Provider) Call(ctx context.Context, req *pb.CallRequest) (*pb.CallResponse, error)

+ func (p *Provider) CheckHealth(ctx context.Context) error

+ func (p *Provider) CursorClose(ctx context.Context, req *pb.CursorCloseRequest) error

+ func (p *Provider) CursorNext(ctx context.Context, req *pb.CursorNextRequest) (*pb.CursorNextResponse, error)

+ func (p *Provider) Describe(ctx context.Context) (*pb.DescribeResponse, error)

+ func (p *Provider) EndSession(ctx context.Context, req *pb.EndSessionRequest) error

+ func (p *Provider) Exited() bool

+ func (p *Provider) InitApp(ctx context.Context, req *pb.InitAppRequest) error

+ func (p *Provider) InitModule(ctx context.Context, req *pb.InitModuleRequest) error

+ func (p *Provider) Kill()

+ type ProviderError struct

+ Code int64

+ Message string

+ func (e *ProviderError) Error() string

+ type ServeConfig struct

+ Modules map[string]ModuleDef

+ ProviderVersion string

+ type Session struct

+ func NewSession(id string) *Session

+ func (s *Session) ClearDefer(key string)

+ func (s *Session) Context() context.Context

+ func (s *Session) Defer(key string, strict bool, fn func(ctx context.Context) error)

+ func (s *Session) End(ctx context.Context) error

+ func (s *Session) Get(key string) any

+ func (s *Session) Id() string

+ func (s *Session) Set(key string, value any)

+ type Set []any

+ type Struct struct

+ Fields map[string]any

+ TypeName string

+ type ThreadState struct

+ AppUrl string

+ Groups []string

+ RequestId string

+ UserEmail string

+ UserId string

+ UserSubject string

+ type Thunk struct

+ Error string

+ Name string

+ Value any

+ type Tuple []any