builtins

Documentation

Overview

Package builtins contains the built-in plugin implementations.

Index

• func IsBuiltIn(pluginName string) bool
• func NewClient(pluginName string) (clients.PluginClient, bool)
• func NewPluginConfigs() map[string]FlagBinder
• func NewPluginMap() map[string]clients.PluginClient
• type FlagBinder

Functions

func IsBuiltIn

func IsBuiltIn(pluginName string) bool

IsBuiltIn returns true if the plugin is a built-in plugin.

func NewClient

func NewClient(pluginName string) (clients.PluginClient, bool)

NewClient returns a new built-in plugin client for the given plugin name.

func NewPluginConfigs

func NewPluginConfigs() map[string]FlagBinder

NewPluginConfigs returns a map of the built-in plugin configurations.

func NewPluginMap

func NewPluginMap() map[string]clients.PluginClient

NewPluginMap returns a map of the built-in plugins.

Types

type FlagBinder

type FlagBinder interface {
	// BindFlags is called to bind the options to the flagset
	// with the given prefix.
	BindFlags(string, *pflag.FlagSet)
	// AsMapStructure is called to convert the options to a map
	// of string keys and values.
	AsMapStructure() map[string]any
	// SetMapStructure is called to set the options from a map
	// of string keys and values.
	SetMapStructure(map[string]any)
}

FlagBinder is an interface implemented by the built-in plugin option sets to bind them to the given flag set.