Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CloseError ¶
func CloseError(v interface{})
CloseError invokes CloseError() method if the object is either Reader or Writer.
Types ¶
type Option ¶
type Option func(*pipe)
Option for creating new Pipes.
func OptionsFromContext ¶
func WithSizeLimit ¶
func WithoutSizeLimit ¶
func WithoutSizeLimit() Option
type Reader ¶
type Reader struct {
// contains filtered or unexported fields
}
Reader is a buf.Reader that reads content from a pipe.
func (*Reader) CloseError ¶
func (r *Reader) CloseError()
CloseError sets the pipe to error state. Both reading and writing from/to the pipe will return io.ErrClosedPipe.
func (*Reader) ReadMultiBuffer ¶
func (r *Reader) ReadMultiBuffer() (buf.MultiBuffer, error)
ReadMultiBuffer implements buf.Reader.
func (*Reader) ReadMultiBufferTimeout ¶
ReadMultiBufferTimeout reads content from a pipe within the given duration, or returns buf.ErrTimeout otherwise.
type Writer ¶
type Writer struct {
// contains filtered or unexported fields
}
Writer is a buf.Writer that writes data into a pipe.
func (*Writer) Close ¶
Close implements io.Closer. After the pipe is closed, writing to the pipe will return io.ErrClosedPipe, while reading will return io.EOF.
func (*Writer) CloseError ¶
func (w *Writer) CloseError()
CloseError sets the pipe to error state. Both reading and writing from/to the pipe will return io.ErrClosedPipe.
func (*Writer) WriteMultiBuffer ¶
func (w *Writer) WriteMultiBuffer(mb buf.MultiBuffer) error
WriteMultiBuffer implements buf.Writer.
Source Files