Documentation
¶
Overview ¶
Package iotools contains a collection of I/O-related utility structs and methods.
Index ¶
Constants ¶
This section is empty.
Variables ¶
ErrPanicWriter is panic'd from the Writer provided to the callback in WriteTracker in the event of an io error.
ErrTimeout is an error returned if the DeadlineReader times out.
Functions ¶
func WriteTracker ¶
WriteTracker helps to write complex writer routines correctly.
This wraps a Writer with an implementation where any Write method will panic with the ErrPanicWriter error, catch that panic, and return the original io error as well as the number of written bytes.
This means that the callback can use its Writer without tracking the number of bytes written, nor any io errors (i.e. it can ignore the return values from write operations entirely).
If no io errors are encountered, this will return the callback's error and the number of written bytes.
Types ¶
type ByteSliceReader ¶
type ByteSliceReader []byte
ByteSliceReader is an io.Reader and io.ByteReader implementation that reads and mutates an underlying byte slice.
func (*ByteSliceReader) Read ¶
func (r *ByteSliceReader) Read(buf []byte) (int, error)
Read implements io.Reader.
func (*ByteSliceReader) ReadByte ¶
func (r *ByteSliceReader) ReadByte() (byte, error)
ReadByte implements io.ByteReader.
type ChainReader ¶
ChainReader is an io.Reader that consumes data sequentially from independent arrays of data to appear as if they were one single concatenated data source.
The underlying io.Reader will be mutated during operation.
func (*ChainReader) Read ¶
func (cr *ChainReader) Read(p []byte) (int, error)
Read implements io.Reader.
func (ChainReader) ReadByte ¶
func (cr ChainReader) ReadByte() (byte, error)
ReadByte implements io.ByteReader.
func (ChainReader) Remaining ¶
func (cr ChainReader) Remaining() int64
Remaining calculates the amount of data left in the ChainReader. It will panic if an error condition in RemainingErr is encountered.
func (ChainReader) RemainingErr ¶
func (cr ChainReader) RemainingErr() (int64, error)
RemainingErr returns the amount of data left in the ChainReader. An error is returned if any reader in the chain is not either nil or a bytes.Reader.
Note that this method iterates over all readers in the chain each time that it's called.
type CountingReader ¶
CountingReader is an io.Reader that counts the number of bytes that are read.
func (*CountingReader) Read ¶
func (c *CountingReader) Read(buf []byte) (int, error)
Read implements io.Reader.
func (*CountingReader) ReadByte ¶
func (c *CountingReader) ReadByte() (byte, error)
ReadByte implements io.ByteReader.
type CountingWriter ¶
type CountingWriter struct {
io.Writer // The underlying io.Writer.
// Count is the number of bytes that have been written.
Count int64
// contains filtered or unexported fields
}
CountingWriter is an io.Writer that counts the number of bytes that are written.
func (*CountingWriter) Write ¶
func (c *CountingWriter) Write(buf []byte) (int, error)
Write implements io.Writer.
func (*CountingWriter) WriteByte ¶
func (c *CountingWriter) WriteByte(b byte) error
WriteByte implements io.ByteWriter.
type DeadlineReader ¶
type DeadlineReader struct {
net.Conn
// Deadline is the read deadline to apply prior to each 'Read()'. It can also
// be set via SetReadTimeout.
Deadline time.Duration
}
DeadlineReader is a wrapper around a net.Conn that applies an idle timeout deadline to the Conn's Read() method.
func (*DeadlineReader) Read ¶
func (r *DeadlineReader) Read(b []byte) (int, error)
Read implements io.Reader.
func (*DeadlineReader) SetReadTimeout ¶
func (r *DeadlineReader) SetReadTimeout(d time.Duration) error
SetReadTimeout implements ReadDeadlineSetter.
Source Files