chunker

package

v0.10.1 Latest Latest Go to latest Published: Jun 14, 2019 License: Apache-2.0 Imports: 2 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

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

This section is empty.

This section is empty.

This section is empty.

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

Chunker converts data read from reader into chunks.

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 (c *Chunker) Close() error

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

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 func(*Chunker)

Option is the configuration func of Chunker.

func ChunkSizeOption(n int) Option

ChunkSizeOption returns an option to set chunk size.

func ValueOption(value interface{}) Option

ValueOption returns an option to set context value to chunks.

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

Stream implements io.Reader.

func NewStream() *Stream

NewStream returns a new stream.

func (s *Stream) Close() error

Close closes reader.

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

Provide provides data for Read.

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

Read puts data into p.