file

Documentation

Index

• Constants
• Variables
• func Run(plugins func() discovery.Plugins, name plugin.Name, config *types.Any) (transport plugin.Transport, impls map[run.PluginCode]interface{}, ...)
• type Options

Constants

const (
	// Kind is the canonical name of the plugin for starting up, etc.
	Kind = "file"

	// EnvDir is the environment variable to use to set the default value of Options.Dir
	EnvDir = "INFRAKIT_INSTANCE_FILE_DIR"
)

Variables

var DefaultOptions = Options{
	Dir: local.Getenv(EnvDir, os.TempDir()),
}

DefaultOptions return an Options with default values filled in.

Functions

func Run

func Run(plugins func() discovery.Plugins, name plugin.Name,
	config *types.Any) (transport plugin.Transport, impls map[run.PluginCode]interface{}, onStop func(), err error)

Run runs the plugin, blocking the current thread. Error is returned immediately if the plugin cannot be started.

Types

type Options

type Options struct {
	// Dir is the path of the directory to store the files
	Dir string
}

Options capture the options for starting up the plugin.