reader

Documentation

Index

• Constants
• Variables
• func ConnReadN(ctx context.Context, reader io.Reader, N int64) ([]byte, error)
• func ConnReadNWithTimeout(reader io.Reader, N int64, after time.Duration) ([]byte, error)
• func IsAcceptedError(err error) bool
• type FrozenReader
  • func (reader FrozenReader) Read(p []byte) (n int, err error)
• type KeyPressReader
  • func (reader KeyPressReader) Read(p []byte) (n int, err error)
  • func (reader *KeyPressReader) Start() error
  • func (reader *KeyPressReader) Stop() error
• type ReusableReadCloser
  • func NewReusableReadCloser(raw interface{}) (*ReusableReadCloser, error)
  • func (r ReusableReadCloser) Close() error
  • func (r ReusableReadCloser) Read(p []byte) (int, error)
• type TimeoutReader
  • func (reader TimeoutReader) Read(p []byte) (n int, err error)

Constants

const (
	// although this is more than enough for most cases
	MaxReadSize = 1 << 23 // 8MB
)

Variables

var ErrTimeout = errors.New("Timeout")

var (
	ErrTooLarge = errors.New("reader: too large only 8MB allowed as per MaxReadSize")
)

Functions

func ConnReadN

func ConnReadN(ctx context.Context, reader io.Reader, N int64) ([]byte, error)

ConnReadN reads at most N bytes from reader and it optimized for connection based readers like net.Conn it should not be used for file/buffer based reading, ConnReadN should be preferred instead of 'conn.Read() without loop' . It ignores EOF, UnexpectedEOF and timeout errors Note: you are responsible for adding a timeout to context

func ConnReadNWithTimeout

func ConnReadNWithTimeout(reader io.Reader, N int64, after time.Duration) ([]byte, error)

ConnReadNWithTimeout is same as ConnReadN but it takes timeout instead of context and it returns error if read does not finish in given time

func IsAcceptedError

func IsAcceptedError(err error) bool

IsAcceptedError checks if the error is accepted error for example: connection refused, io.EOF, io.ErrUnexpectedEOF while reading from connection

Types

type FrozenReader

type FrozenReader struct{}

FrozenReader is a reader that never returns

func (FrozenReader) Read

func (reader FrozenReader) Read(p []byte) (n int, err error)

Read into the buffer

type KeyPressReader

type KeyPressReader struct {
	Timeout time.Duration

	Once       *sync.Once
	Raw        bool
	BufferSize int
	// contains filtered or unexported fields
}

func (KeyPressReader) Read

func (reader KeyPressReader) Read(p []byte) (n int, err error)

Read into the buffer

func (*KeyPressReader) Start

func (reader *KeyPressReader) Start() error

func (*KeyPressReader) Stop

func (reader *KeyPressReader) Stop() error

type ReusableReadCloser

type ReusableReadCloser struct {
	*sync.RWMutex
	io.Reader
	// contains filtered or unexported fields
}

ReusableReadCloser is a reusable reader with no-op close

func NewReusableReadCloser

func NewReusableReadCloser(raw interface{}) (*ReusableReadCloser, error)

NewReusableReadCloser is returned for any type of input

func (ReusableReadCloser) Close

func (r ReusableReadCloser) Close() error

Close is a no-op close of ReusableReadCloser

func (ReusableReadCloser) Read

func (r ReusableReadCloser) Read(p []byte) (int, error)

Read []byte from Reader

type TimeoutReader

type TimeoutReader struct {
	Timeout time.Duration
	Reader  io.Reader
	// contains filtered or unexported fields
}

TimeoutReader is a reader wrapper that stops waiting after Timeout

func (TimeoutReader) Read

func (reader TimeoutReader) Read(p []byte) (n int, err error)

Read into the buffer