pluginfx

type InvalidConstructorError struct {
	Name string
	Type reflect.Type
}

type InvalidLifecycleError struct {
	Name string
	Type reflect.Type
}

type MissingSymbolError struct {
	Name string
	Err  error
}

type Plugin struct {
	// Name is the optional name of the plugin component within the application.  This
	// field is ignored if Anonymous is set.
	Name string

	// Group is the optional value group to place the loaded plugin into.  This field
	// is ignored if Anonymous is set.
	Group string

	// Anonymous controls whether the plugin itself is provided as a component
	// to the enclosing fx.App.  If this field is true, then the plugin is not
	// placed into the fx.App regardless of the values of Name and Group.
	Anonymous bool

	// Path is the plugin's path.  This field is required.
	Path string

	// IgnoreMissingConstructors controls what happens if a symbol in the Constructors
	// field is not present in the plugin.  If this field is true, missing constructor
	// symbols are silently ignored.  Otherwise, missing constructor symbols will shortcircuit
	// application startup with one or more errors.
	IgnoreMissingConstructors bool

	// Constructors are the optional exported functions from the plugin that participate
	// in dependency injection.  Each constructor is passed to fx.Provide.
	Constructors []string

	// IgnoreMissingLifecycle controls what happens if OnStart or OnStop are not symbols
	// in the plugin.  If this field is true and either OnStart or OnStop are not present,
	// no error is raised.  Otherwise, application startup is shortcircuited with one or
	// more errors.
	IgnoreMissingLifecycle bool

	// OnStart is the optional exported function that should be called when the enclosing
	// application is started.
	OnStart string

	// OnStop is the optional exported function that should be called when the enclosing
	// application is stopped.
	OnStop string
}

type Set struct {
	// Group is the optional value group to place each plugin in this set into.  If this
	// field is unset, the loaded plugins are not added as components.
	Group string

	// Paths are the plugin paths to load.
	Paths []string

	// IgnoreMissingConstructors controls what happens if a symbol in the Constructors
	// field is not present in any of the plugins.  If this field is true, missing constructor
	// symbols are silently ignored.  Otherwise, missing constructor symbols will shortcircuit
	// application startup with one or more errors.
	IgnoreMissingConstructors bool

	// Constructors are the optional exported functions from each plugin that participate
	// in dependency injection.  Each constructor is passed to fx.Provide.
	Constructors []string

	// IgnoreMissingLifecycle controls what happens if OnStart or OnStop are not symbols
	// in each plugin.  If this field is true and either OnStart or OnStop are not present,
	// no error is raised.  Otherwise, application startup is shortcircuited with one or
	// more errors.
	IgnoreMissingLifecycle bool

	// OnStart is the optional exported function that should be called when the enclosing
	// application is started.
	OnStart string

	// OnStop is the optional exported function that should be called when the enclosing
	// application is stopped.
	OnStop string
}

type SymbolMap map[string]plugin.Symbol

type SymbolVisitor func(symbolName string, value reflect.Value, lookupErr error) error

type Symbols interface {
	// Lookup returns the value of the given symbol, or an error
	// if no such symbol exists.
	Lookup(string) (plugin.Symbol, error)
}