chunker

Documentation

Index

• type ChunkReader
• type ChunkSource
• type Chunker
  • func NewDefaultChunker(source ChunkSource, setters ...Option) Chunker
• type DefaultChunker
  • func (c *DefaultChunker) Read(ctx context.Context) <-chan []byte
• type Option
  • func Size(s int) Option
• type Options

Types

type ChunkReader

type ChunkReader interface {
	Read(context.Context) <-chan []byte
}

ChunkReader is an interface describing a reader that streams data in []byte chunks.

type ChunkSource

type ChunkSource interface {
	io.ReaderAt
	io.Seeker
	io.Closer
	io.Writer
}

ChunkSource is an interface describing the source of a Chunker.

type Chunker

type Chunker interface {
	ChunkReader
}

Chunker is an interface for embedding all chunking interfaces under one name.

func NewDefaultChunker

func NewDefaultChunker(source ChunkSource, setters ...Option) Chunker

NewDefaultChunker initializes a DefaultChunker with default values.

type DefaultChunker

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

DefaultChunker is a conecrete type that implements the Chunker interface.

func (*DefaultChunker) Read

func (c *DefaultChunker) Read(ctx context.Context) <-chan []byte

Read implements ChunkReader.

type Option

type Option func(*Options)

Option is the functional option func.

func Size

func Size(s int) Option

Size sets the chunk size of the Chunker.

type Options

type Options struct {
	Size int
}

Options is the functional options struct.