api

Documentation

Overview

API package with type definitions

Index

• type BatchTrigger
• type BatchTriggerFunc
  • func (f BatchTriggerFunc) Done(ctx context.Context, item interface{}, index int64) bool
• type BinFunc
  • func (f BinFunc) Apply(ctx context.Context, op1, op2 interface{}) (interface{}, error)
• type BinOperation
• type Collector
• type Emitter
• type Operator
• type ProcError
  • func (e ProcError) Error() string
• type Sink
• type Source
• type UnFunc
  • func (f UnFunc) Apply(ctx context.Context, data interface{}) (interface{}, error)
• type UnOperation

Types

type BatchTrigger

type BatchTrigger interface {
	Done(ctx context.Context, item interface{}, index int64) bool
}

BatchTrigger interface provides logic to trigger when batch is done.

type BatchTriggerFunc

type BatchTriggerFunc func(context.Context, interface{}, int64) bool

BatchTriggerFunc a function type adapter that implements BatchTrigger

func (BatchTriggerFunc) Done

func (f BatchTriggerFunc) Done(ctx context.Context, item interface{}, index int64) bool

Done implements BatchOperation.Done

type BinFunc

type BinFunc func(context.Context, interface{}, interface{}) (interface{}, error)

BinFunc implements BinOperation as type func(context.Context, interface{}, interface{})

func (BinFunc) Apply

func (f BinFunc) Apply(ctx context.Context, op1, op2 interface{}) (interface{}, error)

Apply implements BinOpeartion.Apply

type BinOperation

type BinOperation interface {
	Apply(ctx context.Context, op1, op2 interface{}) (interface{}, error)
}

BinOperation interface represents binary opeartions (i.e. Reduce, etc)

type Collector

type Collector interface {
	SetInput(<-chan interface{})
}

type Emitter

type Emitter interface {
	GetOutput() <-chan interface{}
}

type Operator

type Operator interface {
	Collector
	Emitter
	Exec(drain chan<- error)
}

Operator is an executor node that applies a function on items in the stream

type ProcError

type ProcError struct {
	Err      error
	ProcName string
}

func (ProcError) Error

func (e ProcError) Error() string

type Sink

type Sink interface {
	Collector
	Open(context.Context) <-chan error
}

type Source

type Source interface {
	Emitter
	Open(context.Context) error
}

type UnFunc

type UnFunc func(context.Context, interface{}) (interface{}, error)

UnFunc implements UnOperation as type func (context.Context, interface{})

func (UnFunc) Apply

func (f UnFunc) Apply(ctx context.Context, data interface{}) (interface{}, error)

Apply implements UnOperation.Apply method

type UnOperation

type UnOperation interface {
	Apply(ctx context.Context, data interface{}) (interface{}, error)
}

UnOperation interface represents unary operations (i.e. Map, Filter, etc)