client

Documentation

Index

• func DownloadPlugin(url string, name string, version string) (string, error)
• type CustomCommandExecutor
• type Factory
  • func NewFactory() Factory
• type NoOpHash
  • func (h *NoOpHash) BlockSize() int
  • func (h *NoOpHash) Reset()
  • func (h *NoOpHash) Size() int
  • func (h *NoOpHash) Sum(b []byte) []byte
  • func (h *NoOpHash) Write(p []byte) (n int, err error)
• type PluginInstance
• type Provider

Functions

func DownloadPlugin

func DownloadPlugin(url string, name string, version string) (string, error)

Types

type CustomCommandExecutor

type CustomCommandExecutor interface {
	ExecuteCustomCommand(cmdName string, ctx context.Context, args []string, bazelStartupArgs []string) error
}

CustomCommandExecutor requires the Plugin implementations to provide the ExecuteCustomCommand method so that the Core can ask over gRPC for a specific command to be executed. `cmdName` is the name of the custom command the plugin created.

type Factory

type Factory interface {
	New(config types.PluginConfig, streams ioutils.Streams) (*PluginInstance, error)
}

A Factory class for constructing plugin instances.

func NewFactory

func NewFactory() Factory

type NoOpHash

type NoOpHash struct{}

NoOpHash is a hash.Hash that does nothing. It's used for plugins that are built from source and required to satisfy the upstream plugin system that expects a hash.

func (*NoOpHash) BlockSize

func (h *NoOpHash) BlockSize() int

func (*NoOpHash) Reset

func (h *NoOpHash) Reset()

func (*NoOpHash) Size

func (h *NoOpHash) Size() int

func (*NoOpHash) Sum

func (h *NoOpHash) Sum(b []byte) []byte

func (*NoOpHash) Write

func (h *NoOpHash) Write(p []byte) (n int, err error)

type PluginInstance

type PluginInstance struct {
	plugin.Plugin
	Provider
	CustomCommandExecutor
}

A PluginInstance consists of the underling Plugin as well as any associated objects or metadata.

type Provider

type Provider interface {
	Client() (goplugin.ClientProtocol, error)
	Kill()
}

Provider is an interface for goplugin.Client returned by goplugin.NewClient.