chunkedreader

Documentation

Overview

Package chunkedreader provides functionality for reading a stream in chunks.

Index

• Variables
• type ChunkedReader
  • func New(ctx context.Context, o fs.Object, initialChunkSize int64, maxChunkSize int64, ...) ChunkedReader

Variables

var (
	ErrorFileClosed  = errors.New("file already closed")
	ErrorInvalidSeek = errors.New("invalid seek position")
)

io related errors returned by ChunkedReader

Types

type ChunkedReader

type ChunkedReader interface {
	io.Reader
	io.Seeker
	io.Closer
	fs.RangeSeeker
	Open() (ChunkedReader, error)
}

ChunkedReader describes what a chunked reader can do.

func New

func New(ctx context.Context, o fs.Object, initialChunkSize int64, maxChunkSize int64, streams int) ChunkedReader

New returns a ChunkedReader for the Object.

An initialChunkSize of <= 0 will disable chunked reading. If maxChunkSize is greater than initialChunkSize, the chunk size will be doubled after each chunk read with a maximum of maxChunkSize. A Seek or RangeSeek will reset the chunk size to it's initial value