module

Documentation

Index

• func List() (m []string)
• func Register(name string, newFactory func() Factory)
• type Config
  • func (c *Config) UnmarshalJSON(data []byte) error
  • func (c *Config) UnmarshalYAML(unmarshal func(interface{}) error) error
• type Environment
• type Factory
• type Module
  • func New(cfg *Config, env *Environment) (Module, error)

Functions

func List

func List() (m []string)

List returns all available modules names.

func Register

func Register(name string, newFactory func() Factory)

Register registers a new Module Factory. If a Module Factory already exists for the supplied name, it will be replaced.

Types

type Config

type Config struct {
	Factory
}

Config represents a module configuration.

func (*Config) UnmarshalJSON

func (c *Config) UnmarshalJSON(data []byte) error

UnmarshalJSON implements JSON interface to customize JSON unmarshalling process. It detects the module name (field: Module) and generates the appropriate module's constructor.

func (*Config) UnmarshalYAML

func (c *Config) UnmarshalYAML(unmarshal func(interface{}) error) error

UnmarshalYAML implements YAML interface to customize JSON unmarshalling process. It detects the module name (field: Module) and generates the appropriate module's constructor.

type Environment

type Environment struct {
	// Logger provides logging facility to a module.
	Logger *log.Logger
	// Store provides a collection's access facilities to a module.
	Store *store.Store
}

Environment represents a set of facilities that a module can access to to interact with its environment (logging, gostore access, ...).

type Factory

type Factory interface {
	// NewModule creates a new module according to Factory configuration and to
	// gostore's modules environment.
	NewModule(*Environment) (Module, error)
}

Factory represents a module provider.

type Module

type Module interface {
	// Process performs an action on a collection's record
	Process(*store.Record) error
}

Module represents a gostore's module that can act on collection's records.

func New

func New(cfg *Config, env *Environment) (Module, error)

New creates a new Module.