io

Documentation

Index

• type CancelableReadCloser
  • func NewCancelableReadCloser(ctx context.Context) *CancelableReadCloser
  • func (crc *CancelableReadCloser) Close() error
  • func (crc *CancelableReadCloser) Read(buf []byte) (int, error)
  • func (crc *CancelableReadCloser) Start(input io.Reader) error

Types

type CancelableReadCloser

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

CancelableReadCloser essentially reads from the provided reader so that it can be read by the Read(..) method.

The read allows the caller to cancel (i.e via close) the reader without waiting for the read to be stuck in a blocking mode.

see: _examples/ex_cancelable_reader.go for example usage

func NewCancelableReadCloser

func NewCancelableReadCloser(ctx context.Context) *CancelableReadCloser

func (*CancelableReadCloser) Close

func (crc *CancelableReadCloser) Close() error

func (*CancelableReadCloser) Read

func (crc *CancelableReadCloser) Read(buf []byte) (int, error)

func (*CancelableReadCloser) Start

func (crc *CancelableReadCloser) Start(input io.Reader) error