plugin

Documentation

Overview

Package plugin provides the plugin side of the plugin mechanism. Individual plugins have to implement the provider interface, pass it to a new plugin instance, and call run.

Index

• type Plugin
  • func New(provider Provider, debug bool) *Plugin
  • func (p *Plugin) Run(log *zap.SugaredLogger) error
• type Provider

Types

type Plugin

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

Plugin implements a convenient helper to map the request to the given provider and return the response.

func New

func New(provider Provider, debug bool) *Plugin

New creates a new plugin.

func (*Plugin) Run

func (p *Plugin) Run(log *zap.SugaredLogger) error

Run looks for the given request and executes it.

type Provider

type Provider interface {
	UserData(log *zap.SugaredLogger, req plugin.UserDataRequest) (string, error)
}

Provider defines the interface each plugin has to implement for the retrieval of the userdata based on the given arguments.