io

Documentation

Overview

This package provides an interface to functions and structs in the standard io package to facilitate mocking.

Index

• Constants
• Variables
• func NewIO() ioFacade
• type ByteReader
• type ByteScanner
• type ByteWriter
• type Closer
• type IO
• type LimitedReader
• type OffsetWriter
• type PipeReader
• type PipeWriter
• type ReadCloser
• type ReadSeekCloser
• type ReadSeeker
• type ReadWriteCloser
• type ReadWriteSeeker
• type ReadWriter
• type Reader
• type ReaderAt
• type ReaderFrom
• type RuneReader
• type RuneScanner
• type SectionReader
• type Seeker
• type StringWriter
• type WriteCloser
• type WriteSeeker
• type Writer
• type WriterAt
• type WriterTo

Constants

const (
	SeekStart   = io.SeekStart
	SeekCurrent = io.SeekCurrent
	SeenEnd     = io.SeekEnd
)

Variables

var (
	EOF              = io.EOF
	ErrClosedPipe    = io.ErrClosedPipe
	ErrNoProgress    = io.ErrNoProgress
	ErrShortBuffer   = io.ErrShortBuffer
	ErrShortWrite    = io.ErrShortWrite
	ErrUnexpectedEOF = io.ErrUnexpectedEOF
)

Functions

func NewIO

func NewIO() ioFacade

Types

type ByteReader

type ByteReader = io.ByteReader

type ByteScanner

type ByteScanner = io.ByteScanner

type ByteWriter

type ByteWriter = io.ByteWriter

type Closer

type Closer = io.Closer

type IO

type IO interface {
	// Functions:
	Copy(Writer, Reader) (int64, error)
	CopyBuffer(Writer, Reader, []byte) (int64, error)
	CopyN(Writer, Reader, int64) (int64, error)
	Pipe() (PipeReader, PipeWriter)
	ReadAll(Reader) ([]byte, error)
	ReadAtLeast(Reader, []byte, int) (int, error)
	ReadFull(Reader, []byte) (int, error)
	WriteString(Writer, string) (int, error)

	// Constructors:
	NewLimitedReader(Reader, int64) LimitedReader

	NewOffsetWriter(WriterAt, int64) OffsetWriter

	NopCloser(Reader) ReadCloser

	LimitReader(Reader, int64) Reader
	MultiReader(...Reader) Reader
	TeeReader(Reader, Writer) Reader

	NewSectionReader(ReaderAt, int64, int64) SectionReader

	MultiWriter(...Writer) Writer
}

type LimitedReader

type LimitedReader interface {
	Read([]byte) (int, error)
}

type OffsetWriter

type OffsetWriter interface {
	Seek(int64, int) (int64, error)
	Write([]byte) (int, error)
	WriteAt([]byte, int64) (int, error)
}

type PipeReader

type PipeReader interface {
	Close() error
	CloseWithError(error) error
	Read([]byte) (int, error)
}

type PipeWriter

type PipeWriter interface {
	Close() error
	CloseWithError(error) error
	Write([]byte) (int, error)
}

type ReadCloser

type ReadCloser = io.ReadCloser

type ReadSeekCloser

type ReadSeekCloser = io.ReadSeekCloser

type ReadSeeker

type ReadSeeker = io.ReadSeeker

type ReadWriteCloser

type ReadWriteCloser = io.ReadWriteCloser

type ReadWriteSeeker

type ReadWriteSeeker = io.ReadWriteSeeker

type ReadWriter

type ReadWriter = io.ReadWriter

type Reader

type Reader = io.Reader

type ReaderAt

type ReaderAt = io.ReaderAt

type ReaderFrom

type ReaderFrom = io.ReaderFrom

type RuneReader

type RuneReader = io.RuneReader

type RuneScanner

type RuneScanner = io.RuneScanner

type SectionReader

type SectionReader interface {
	Outer() (ReaderAt, int64, int64)
	Read([]byte) (int, error)
	ReadAt([]byte, int64) (int, error)
	Seek(int64, int) (int64, error)
	Size() int64
}

type Seeker

type Seeker = io.Seeker

type StringWriter

type StringWriter = io.StringWriter

type WriteCloser

type WriteCloser = io.WriteCloser

type WriteSeeker

type WriteSeeker = io.WriteSeeker

type Writer

type Writer = io.Writer

type WriterAt

type WriterAt = io.WriterAt

type WriterTo

type WriterTo = io.WriterTo