binaryio

Documentation

Index

• type MinimumReader
  • func MinReader(r io.Reader, minNumberOfBytesToRead int64) *MinimumReader
  • func (r *MinimumReader) Close() error
  • func (r *MinimumReader) Read(p []byte) (n int, err error)

Types

type MinimumReader

type MinimumReader struct {
	R                      io.Reader
	MinNumberOfBytesToRead int64 // Min number of bytes we need to read from the reader
}

MinimumReader is the implementation for MinReader.

func MinReader

func MinReader(r io.Reader, minNumberOfBytesToRead int64) *MinimumReader

MinReader reads from R but ensures there is at least N bytes read from the reader. The reader should call Close() when they are done reading. Closing the MinReader will read and discard any unread bytes up to MinNumberOfBytesToRead. CLosing the MinReader does NOT close the underlying reader. The underlying implementation is a MinimumReader, which implements ReaderCloser.

func (*MinimumReader) Close

func (r *MinimumReader) Close() error

Close does not close the underlying reader, only the MinimumReader

func (*MinimumReader) Read

func (r *MinimumReader) Read(p []byte) (n int, err error)