plugin

Documentation

Index

• Constants
• Variables
• type GRPCServiceRegisterer
• type Option
  • func WithFlagSet(flags *pflag.FlagSet) Option
• type Plugin
  • func New(id, version string, runnable Runnable, opts ...Option) *Plugin
  • func (p Plugin) FlagSet() *pflag.FlagSet
  • func (p Plugin) ID() string
  • func (p Plugin) Runnable() Runnable
  • func (p Plugin) Version() string
• type Runnable
• type Storage
  • func NewStorage(l *zap.Logger, v *viper.Viper) *Storage
  • func (s *Storage) Add(p *Plugin)
  • func (s *Storage) All() map[string]*Plugin
  • func (s *Storage) Get(id string) (*Plugin, error)
  • func (s *Storage) LoadShared(path string) error
  • func (s *Storage) MergeFlagSets(f *pflag.FlagSet)
  • func (s *Storage) RegisterGRPCServices(svr *grpc.Server) error

Constants

const SetupFuncName = "Setup"

Variables

var (
	ErrPluginNotFound      = errors.New("plugin not found")
	ErrPluginSetupFuncCast = errors.New("could not cast setup function")
)

Types

type GRPCServiceRegisterer

type GRPCServiceRegisterer interface {
	Register(*grpc.Server) error
}

type Option

type Option func(*Plugin)

func WithFlagSet

func WithFlagSet(flags *pflag.FlagSet) Option

type Plugin

type Plugin struct {
	// contains filtered or unexported fields
}

func New

func New(id, version string, runnable Runnable, opts ...Option) *Plugin

func (Plugin) FlagSet

func (p Plugin) FlagSet() *pflag.FlagSet

func (Plugin) ID

func (p Plugin) ID() string

func (Plugin) Runnable

func (p Plugin) Runnable() Runnable

func (Plugin) Version

func (p Plugin) Version() string

type Runnable

type Runnable func(*zap.Logger, *viper.Viper) (GRPCServiceRegisterer, error)

type Storage

type Storage struct {
	// contains filtered or unexported fields
}

func NewStorage

func NewStorage(l *zap.Logger, v *viper.Viper) *Storage

func (*Storage) Add

func (s *Storage) Add(p *Plugin)

func (*Storage) All

func (s *Storage) All() map[string]*Plugin

func (*Storage) Get

func (s *Storage) Get(id string) (*Plugin, error)

func (*Storage) LoadShared

func (s *Storage) LoadShared(path string) error

func (*Storage) MergeFlagSets

func (s *Storage) MergeFlagSets(f *pflag.FlagSet)

func (*Storage) RegisterGRPCServices

func (s *Storage) RegisterGRPCServices(svr *grpc.Server) error