zio

Documentation

Index

• Variables
• func CloseAll(files ...io.Closer) error
• func CtxReader(ctx context.Context, r io.Reader) io.Reader
• func CutReader(r io.Reader, needle []byte) (left []byte, remaining io.Reader, err error)
• func DelayedReader(r io.Reader, delay time.Duration) io.Reader
• func HasPrefix(r io.Reader, prefix []byte) (ok bool, err error)
• func HeadRecorder(writer io.Writer, max uint) *headRecorder
• func MaxReader(reader io.Reader, limit int) io.Reader
• func MultiCloser(closers ...io.Closer) io.Closer
• func NewUnbufferedReaderAt(r io.Reader) io.ReaderAt
• func ReadLines(r io.Reader) (lines []string, err error)
• func ReadLinesSplit(r io.Reader, split bufio.SplitFunc) (lines []string, err error)
• func ReadersMatch(r1 io.Reader, r2 io.Reader, bufSize int) error
• func TimeoutReader(reader io.Reader, timeout time.Duration) io.Reader
• type CombineReaderCloser
• type CombineWriterCloser
• type ReaderToReadCloser
  • func (r *ReaderToReadCloser) Close() error
• type ReaderToSeeker
  • func NewReaderToSeeker(reader io.Reader) *ReaderToSeeker
  • func (r *ReaderToSeeker) Close() (err error)
  • func (r *ReaderToSeeker) Read(d []byte) (n int, err error)
  • func (r *ReaderToSeeker) Seek(offset int64, whence int) (newOffset int64, err error)

Variables

var (
	ErrExceededMax = errors.New("Exceeded limit of maxReader")
)

Functions

func CloseAll

func CloseAll(files ...io.Closer) error

Close multiple Closers returning an error if any of them produce one

func CtxReader

func CtxReader(ctx context.Context, r io.Reader) io.Reader

func CutReader

func CutReader(r io.Reader, needle []byte) (left []byte, remaining io.Reader, err error)

func DelayedReader

func DelayedReader(r io.Reader, delay time.Duration) io.Reader

func HasPrefix

func HasPrefix(r io.Reader, prefix []byte) (ok bool, err error)

Determine if the given reader starts with the prefix

func HeadRecorder

func HeadRecorder(writer io.Writer, max uint) *headRecorder

func MaxReader

func MaxReader(reader io.Reader, limit int) io.Reader

func MultiCloser

func MultiCloser(closers ...io.Closer) io.Closer

func NewUnbufferedReaderAt

func NewUnbufferedReaderAt(r io.Reader) io.ReaderAt

func ReadLines

func ReadLines(r io.Reader) (lines []string, err error)

A utility function that uses a bufio.Scanner to read lines from an io.Reader using bufio.ScanLines

func ReadLinesSplit

func ReadLinesSplit(r io.Reader, split bufio.SplitFunc) (lines []string, err error)

A utility function that uses a bufio.Scanner to read lines from an io.Reader using the provided split function

func ReadersMatch

func ReadersMatch(r1 io.Reader, r2 io.Reader, bufSize int) error

Determine if two readers have the same data. Returns an error if they don't

func TimeoutReader

func TimeoutReader(reader io.Reader, timeout time.Duration) io.Reader

Types

type CombineReaderCloser

type CombineReaderCloser struct {
	io.Reader
	io.Closer
}

type CombineWriterCloser

type CombineWriterCloser struct {
	io.Writer
	io.Closer
}

type ReaderToReadCloser

type ReaderToReadCloser struct {
	io.Reader
}

func (*ReaderToReadCloser) Close

func (r *ReaderToReadCloser) Close() error

type ReaderToSeeker

type ReaderToSeeker struct {
	IsRecording bool
	// contains filtered or unexported fields
}

Add seeking capability to a reader by storing the read data in memory

func NewReaderToSeeker

func NewReaderToSeeker(reader io.Reader) *ReaderToSeeker

func (*ReaderToSeeker) Close

func (r *ReaderToSeeker) Close() (err error)

func (*ReaderToSeeker) Read

func (r *ReaderToSeeker) Read(d []byte) (n int, err error)

func (*ReaderToSeeker) Seek

func (r *ReaderToSeeker) Seek(offset int64, whence int) (newOffset int64, err error)