plug

README

plug

Plugin system for Snart.

Documentation

Overview

Package plug provides plugin functionality for Snart.

Index

• Variables
• type Base
  • func (b *Base) Gamers() []gamer.Gamer
  • func (b *Base) Intents() gateway.Intents
  • func (b *Base) PlugDB(d *db.DB)
  • func (b *Base) PlugErr(e chan error)
  • func (b *Base) PlugRoute(r *route.Route)
  • func (b *Base) PlugState(s *state.State)
  • func (b *Base) Unload() error
• type Plug
  • func Load(name string) (Plug, error)

Variables

var Dirs = []string{
	".",
	"plugs",
}

Dirs is a list of directories to search for Plugs.

var ErrNoPlug = errors.New("no such plug")

ErrNoPlug occurs when a named Plug cannot be found.

Types

type Base

type Base struct {
	DB    *db.DB
	State *state.State
	Route *route.Route
	Err   chan error
}

Base is a Plug that provides stub functionality to be embedded into other Plugs.

func (*Base) Gamers

func (b *Base) Gamers() []gamer.Gamer

Gamers returns additional gamer.Gamers to be added to the Queue.

func (*Base) Intents

func (b *Base) Intents() gateway.Intents

Intents returns additional Intents to be ORed in.

func (*Base) PlugDB

func (b *Base) PlugDB(d *db.DB)

PlugDB loads the given db.DB into the Base.

func (*Base) PlugErr

func (b *Base) PlugErr(e chan error)

PlugErr loads the given error channel into the Base.

func (*Base) PlugRoute

func (b *Base) PlugRoute(r *route.Route)

PlugRoute loads the given Route into the Base.

func (*Base) PlugState

func (b *Base) PlugState(s *state.State)

PlugState loads the given State into the Base.

func (*Base) Unload

func (b *Base) Unload() error

Unload removes all of the Plug's associations.

type Plug

type Plug interface {
	String() string

	PlugDB(*db.DB)
	PlugState(*state.State)
	PlugRoute(*route.Route)
	PlugErr(chan error)

	Intents() gateway.Intents
	Gamers() []gamer.Gamer

	Unload() error
}

Plug provides all the components of a Snart plugin.

func Load

func Load(name string) (Plug, error)

Load loads and returns the named Plug.