mappers

type GonxMapper ¶

type GonxMapper[T MapInitialisedRow] struct {
	// contains filtered or unexported fields
}

func NewGonxMapper[T MapInitialisedRow](formats ...string) *GonxMapper[T]

func (c *GonxMapper[T]) Identifier() string

func (c *GonxMapper[T]) Map(_ context.Context, a any, opts_ ...MapOption[T]) (T, error)

type GrokMapper ¶ added in v0.2.0

type GrokMapper[T MapInitialisedRow] struct {
	// contains filtered or unexported fields
}

func NewGrokMapper[T MapInitialisedRow](layout string, patterns map[string]string) (*GrokMapper[T], error)

func (c *GrokMapper[T]) GetRegex() (_ string, err error)

func (c *GrokMapper[T]) Identifier() string

func (c *GrokMapper[T]) Map(_ context.Context, a any, opts ...MapOption[T]) (T, error)

type HeaderHandler ¶ added in v0.4.0

type HeaderHandler interface {
	OnHeader(header []string)
}

HeaderHandler is an interface which provides a method for handling the header row it should be implemented by any mapper which wishes to be notified of the header row

type MapInitialisedRow ¶ added in v0.2.0

type MapInitialisedRow interface {
	InitialiseFromMap(m map[string]string) error
}

MapInitialisedRow is an interface which provides a means to initialise a row struct from a string map this is used in combination with the GonxMapper/GrokMapper

type MapOption ¶ added in v0.2.0

type MapOption[R any] func(Mapper[R])

func WithHeader[R any](header []string) MapOption[R]

type Mapper ¶ added in v0.2.0

type Mapper[R any] interface {
	Identifier() string
	// Map converts raw rows to the desired format (type 'R')
	Map(context.Context, any, ...MapOption[R]) (R, error)
}

Mapper is a generic interface which provides a method for mapping raw source data into row structs R is the type of the row struct which the mapperFunc outputs

type RegexMapper ¶ added in v0.2.0

type RegexMapper[T MapInitialisedRow] struct {
	// contains filtered or unexported fields
}

func NewRegexMapper[T MapInitialisedRow](pattern string) (*RegexMapper[T], error)

func (c *RegexMapper[T]) Identifier() string

func (c *RegexMapper[T]) Map(_ context.Context, a any, opts ...MapOption[T]) (T, error)