api

type ErrorCode ¶ added in v0.19.0

type ErrorCode int

const (
	NoError ErrorCode = iota
	UnknownError
	BadInputParameterError
	MissingInputParameterError
	SourceConnectionError
)

type ErrorResult ¶ added in v0.19.0

type ErrorResult struct {
	ErrorMessage string
	ErrorCode    ErrorCode
}

type Info ¶ added in v0.12.0

type Info interface {
	PluginInfo() PluginInfo
}

Info interface needs to be implemented by all plugins to provide basic plugin information.

type InfoPlugin ¶ added in v0.12.0

type InfoPlugin struct {
	Impl Info
}

InfoPlugin is used on the server (CLI) and client (plugin) side to integrate with the plugin system. A plugin should not be using this directly, but instead depend on the cli-plugin-base library to register the plugins.

func (InfoPlugin) Client(b *plugin.MuxBroker, c *rpc.Client) (interface{}, error)

func (p *InfoPlugin) Server(*plugin.MuxBroker) (interface{}, error)

type ParameterInfo ¶ added in v0.12.0

type ParameterInfo struct {
	Name        string
	Description string
	Mandatory   bool
}

ParameterInfo contains the information about a parameter. This is used to inform the CLI user what command-line parameters are expected explicitly for this target (plugin).

func (i ParameterInfo) String() string

type PluginInfo ¶ added in v0.12.0

type PluginInfo struct {
	Name        string
	Description string
	Version     Version
	Parameters  []ParameterInfo
}

PluginInfo represents the information about a plugin.

func (i PluginInfo) String() string

type Version ¶ added in v0.12.0

type Version struct {
	MajorVersion int
	MinorVersion int
	PatchVersion int
}

Version contains semantic versioning information of the plugin

func (i Version) String() string