source

Documentation

Overview

Package source contains several implementations of the batch.Source interface.

Index

• type Channel
  • func (s *Channel) Read(ctx context.Context, ps *batch.PipelineStage)
• type Error
  • func (s *Error) Read(ctx context.Context, ps *batch.PipelineStage)
• type Nil
  • func (s *Nil) Read(ctx context.Context, ps *batch.PipelineStage)

Types

type Channel

type Channel struct {
	Input <-chan interface{}
}

Channel is a Source that reads from input until it is closed. The input channel can be buffered or unbuffered.

func (*Channel) Read

func (s *Channel) Read(ctx context.Context, ps *batch.PipelineStage)

Read reads from items until the input channel is closed.

type Error

type Error struct {
	Err error
}

Error is a Source that returns an error and then closes immediately. It can be used as a mock Source.

func (*Error) Read

func (s *Error) Read(ctx context.Context, ps *batch.PipelineStage)

Read returns an error and then closes.

type Nil

type Nil struct {
	Duration time.Duration
}

Nil is a Source that doesn't read any data. Instead it closes the pipeline stage after specified duration. It can be used as a mock Source.

func (*Nil) Read

func (s *Nil) Read(ctx context.Context, ps *batch.PipelineStage)

Read doesn't read anything.