chunker

Documentation

Overview

Package chunker provides functionalities to create chunks from an io.Reader and also create an io.Reader from chunks.

Index

• type Chunker
  • func New(r io.Reader, chunks chan Data, err chan error, options ...Option) *Chunker
  • func (c *Chunker) Close() error
• type Data
• type Option
  • func ChunkSizeOption(n int) Option
  • func ValueOption(value interface{}) Option
• type Stream
  • func NewStream() *Stream
  • func (s *Stream) Close() error
  • func (s *Stream) Provide(data []byte)
  • func (s *Stream) Read(p []byte) (n int, err error)

Types

type Chunker

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

Chunker converts data read from reader into chunks.

func New

func New(r io.Reader, chunks chan Data, err chan error, options ...Option) *Chunker

New returns a new chunker for r and it forwards each chunk to chunks channel. an error will be sent to err channel if chunking fails.

func (*Chunker) Close

func (c *Chunker) Close() error

Close will stop reading from reader and no more chunks will be emitted.

type Data

type Data struct {
	// Value carries the context value of data chunk.
	Value interface{}

	// Data is data chunk.
	Data []byte
}

Data represents a data chunk.

type Option

type Option func(*Chunker)

Option is the configuration func of Chunker.

func ChunkSizeOption

func ChunkSizeOption(n int) Option

ChunkSizeOption returns an option to set chunk size.

func ValueOption

func ValueOption(value interface{}) Option

ValueOption returns an option to set context value to chunks.

type Stream

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

Stream implements io.Reader.

func NewStream

func NewStream() *Stream

NewStream returns a new stream.

func (*Stream) Close

func (s *Stream) Close() error

Close closes reader.

func (*Stream) Provide

func (s *Stream) Provide(data []byte)

Provide provides data for Read.

func (*Stream) Read

func (s *Stream) Read(p []byte) (n int, err error)

Read puts data into p.