ioext

Documentation

Overview

Package ioext provides io utilities.

Index

• Variables
• func ChainCloser(closers ...io.Closer) io.Closer
• func CompositeReadCloser(reader io.Reader, closer io.Closer) io.ReadCloser
• func CompositeReadWriteCloser(reader io.Reader, writer io.Writer, closer io.Closer) io.ReadWriteCloser
• func CompositeWriteCloser(writer io.Writer, closer io.Closer) io.WriteCloser
• func LockedWriter(writer io.Writer) io.Writer
• func NopWriteCloser(writer io.Writer) io.WriteCloser
• func ReadAllAndClose(readCloser io.ReadCloser) ([]byte, error)
• func ReaderAtForReader(reader io.Reader) (io.ReaderAt, error)

Variables

var (
	// DiscardReader is an io.Reader in which all calls return 0 and io.EOF.
	DiscardReader io.Reader = discardReader{}
	// DiscardReadCloser is an io.ReadCloser in which all calls return 0 and io.EOF.
	DiscardReadCloser io.ReadCloser = io.NopCloser(DiscardReader)
	// DiscardWriteCloser is a discard io.WriteCloser.
	DiscardWriteCloser io.WriteCloser = NopWriteCloser(io.Discard)
	// NopCloser is a no-op closer.
	NopCloser = nopCloser{}
)

Functions

func ChainCloser

func ChainCloser(closers ...io.Closer) io.Closer

ChainCloser chains the closers by calling them in order.

func CompositeReadCloser

func CompositeReadCloser(reader io.Reader, closer io.Closer) io.ReadCloser

CompositeReadCloser returns a io.ReadCloser that is a composite of the Reader and Closer.

func CompositeReadWriteCloser

func CompositeReadWriteCloser(reader io.Reader, writer io.Writer, closer io.Closer) io.ReadWriteCloser

CompositeReadWriteCloser returns a io.ReadWriteCloser that is a composite of the Reader, Writer, and Closer.

func CompositeWriteCloser

func CompositeWriteCloser(writer io.Writer, closer io.Closer) io.WriteCloser

CompositeWriteCloser returns a io.WriteCloser that is a composite of the Writer and Closer.

func LockedWriter

func LockedWriter(writer io.Writer) io.Writer

LockedWriter creates a locked Writer.

func NopWriteCloser

func NopWriteCloser(writer io.Writer) io.WriteCloser

NopWriteCloser returns an io.WriteCloser with a no-op Close method wrapping the provided io.Writer.

func ReadAllAndClose

func ReadAllAndClose(readCloser io.ReadCloser) ([]byte, error)

ReadAllAndClose reads all the data and then closes the ReadCloser.

func ReaderAtForReader

func ReaderAtForReader(reader io.Reader) (io.ReaderAt, error)

ReaderAtForReader converts an io.Reader to an io.ReaderAt.