formatters

Documentation

Index

• type Formatter
  • func NewFormatter(name string, setters ...FormatterOption) Formatter
  • func (f *Formatter) Format(ctx context.Context, record shared.Record) (bool, error)
  • func (f *Formatter) Name() string
  • func (f *Formatter) String() string
• type FormatterConstructor
• type FormatterError
  • func (e *FormatterError) Error() string
• type FormatterOption
  • func Description(description string) FormatterOption
  • func Disabled(disabled bool) FormatterOption
  • func ID(id string) FormatterOption
  • func Name(name string) FormatterOption
• type FormatterRepository
  • func GetFormatterRepository() *FormatterRepository
  • func NewFormatterRepository() FormatterRepository
  • func (apr *FormatterRepository) GetFormatter(name string) (IFormatter, error)
  • func (apr *FormatterRepository) HasFormatter(name string) bool
  • func (apr *FormatterRepository) LoadFormatters(path string) error
  • func (apr *FormatterRepository) RegisterFormatter(formatter IFormatter) error
• type IFormatter

Types

type Formatter

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

func NewFormatter

func NewFormatter(name string, setters ...FormatterOption) Formatter

func (*Formatter) Format

func (f *Formatter) Format(ctx context.Context, record shared.Record) (bool, error)

func (*Formatter) Name

func (f *Formatter) Name() string

func (*Formatter) String

func (f *Formatter) String() string

type FormatterConstructor

type FormatterConstructor func(config map[string]string) (IFormatter, error)

type FormatterError

type FormatterError struct {
	Message string
}

FormatterError custom error for Formatter

func (*FormatterError) Error

func (e *FormatterError) Error() string

type FormatterOption

type FormatterOption func(*Formatter)

func Description

func Description(description string) FormatterOption

func Disabled

func Disabled(disabled bool) FormatterOption

func ID

func ID(id string) FormatterOption

func Name

func Name(name string) FormatterOption

type FormatterRepository

type FormatterRepository struct {
	Formatters map[string]IFormatter
	// contains filtered or unexported fields
}

func GetFormatterRepository

func GetFormatterRepository() *FormatterRepository

func NewFormatterRepository

func NewFormatterRepository() FormatterRepository

func (*FormatterRepository) GetFormatter

func (apr *FormatterRepository) GetFormatter(name string) (IFormatter, error)

func (*FormatterRepository) HasFormatter

func (apr *FormatterRepository) HasFormatter(name string) bool

func (*FormatterRepository) LoadFormatters

func (apr *FormatterRepository) LoadFormatters(path string) error

func (*FormatterRepository) RegisterFormatter

func (apr *FormatterRepository) RegisterFormatter(formatter IFormatter) error

type IFormatter

type IFormatter interface {
	Format(ctx context.Context, record shared.Record) (bool, error)
	Name() string
	String() string
}