generator

Documentation

Overview

Package generator provides basic interface to log generators. It's primary job is to wrap specific implementations of log generators and provide a shared public interface.

Index

• Variables
• func Register(name string, factory Factory) error
• type Factory
  • func GetFactory(name string) (Factory, error)
• type Generator
  • func New(cfg *ucfg.Config) (Generator, error)

Variables

var (
	FunctionMap = template.FuncMap{
		"ToLower": strings.ToLower,
		"ToUpper": strings.ToUpper,
	}
)

Functions

func Register

func Register(name string, factory Factory) error

Register associates a generator name with the generator factory.

Types

type Factory

type Factory = func(*ucfg.Config) (Generator, error)

Factory is the function signature of each generators New function. Given a config it returns a generator or an error.

func GetFactory

func GetFactory(name string) (Factory, error)

GetFactory retrieves a factory for a given name, or returns an error if there isn't a factory associated with that name.

type Generator

type Generator interface {
	Next() ([]byte, error)
}

Generator is the interface that wraps the Next method.

Next generates the next log message and returns it as an array of bytes.

func New

func New(cfg *ucfg.Config) (Generator, error)

New creates a new instance of the generator that is specified by the "type" in the ucfg.Config that is passed in. If no matching generator is found for that type than an error is returned.