chunkreader

README

chunkreader

Package chunkreader provides an opinionated, efficient buffered reader.

Extracted from original implementation in https://github.com/jackc/pgx.

Documentation

Overview

Package chunkreader provides an opinionated, efficient buffered reader.

Index

• type ChunkReader
  • func NewChunkReader(r io.Reader) *ChunkReader
  • func NewChunkReaderEx(r io.Reader, options Options) (*ChunkReader, error)
  • func (r *ChunkReader) Next(n int) (buf []byte, err error)
• type Options

Types

type ChunkReader

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

ChunkReader is a io.Reader wrapper that minimizes reads and memory allocations.

func NewChunkReader

func NewChunkReader(r io.Reader) *ChunkReader

func NewChunkReaderEx

func NewChunkReaderEx(r io.Reader, options Options) (*ChunkReader, error)

func (*ChunkReader) Next

func (r *ChunkReader) Next(n int) (buf []byte, err error)

Next returns buf filled with the next n bytes. If an error occurs, buf will be nil.

type Options

type Options struct {
	MinBufLen int // Minimum buffer length
}