pipe

Documentation

Index

• Constants
• func Dial(ctx context.Context, addr string) (c net.Conn, err error)
• func Listen(addr string) (l net.Listener, err error)
• func Pipe() (*Reader, *Writer)
• type Reader
  • func (r *Reader) Close() error
  • func (r *Reader) CloseWithError(err error) error
  • func (r *Reader) Read(data []byte) (n int, err error)
  • func (r *Reader) SetDeadline(t time.Time)
• type Writer
  • func (w *Writer) Close() error
  • func (w *Writer) CloseWithError(err error) error
  • func (w *Writer) SetDeadline(t time.Time)
  • func (w *Writer) Write(data []byte) (n int, err error)

Constants

const Network = "pipe"

Functions

func Dial

func Dial(ctx context.Context, addr string) (c net.Conn, err error)

func Listen

func Listen(addr string) (l net.Listener, err error)

func Pipe

func Pipe() (*Reader, *Writer)

Pipe creates a synchronous in-memory pipe. It can be used to connect code expecting an io.Reader with code expecting an io.Writer.

Reads and Writes on the pipe are matched one to one except when multiple Reads are needed to consume a single Write. That is, each Write to the PipeWriter blocks until it has satisfied one or more Reads from the PipeReader that fully consume the written data. The data is copied directly from the Write to the corresponding Read (or Reads); there is no internal buffering.

It is safe to call Read and Write in parallel with each other or with Close. Parallel calls to Read and parallel calls to Write are also safe: the individual calls will be gated sequentially.

Types

type Reader

type Reader struct {
	// contains filtered or unexported fields
}

A PipeReader is the read half of a pipe.

func (*Reader) Close

func (r *Reader) Close() error

Close closes the reader; subsequent writes to the write half of the pipe will return the error ErrClosedPipe.

func (*Reader) CloseWithError

func (r *Reader) CloseWithError(err error) error

CloseWithError closes the reader; subsequent writes to the write half of the pipe will return the error err.

CloseWithError never overwrites the previous error if it exists and always returns nil.

func (*Reader) Read

func (r *Reader) Read(data []byte) (n int, err error)

Read implements the standard Read interface: it reads data from the pipe, blocking until a writer arrives or the write end is closed. If the write end is closed with an error, that error is returned as err; otherwise err is EOF.

func (*Reader) SetDeadline

func (r *Reader) SetDeadline(t time.Time)

type Writer

type Writer struct {
	// contains filtered or unexported fields
}

A PipeWriter is the write half of a pipe.

func (*Writer) Close

func (w *Writer) Close() error

Close closes the writer; subsequent reads from the read half of the pipe will return no bytes and EOF.

func (*Writer) CloseWithError

func (w *Writer) CloseWithError(err error) error

CloseWithError closes the writer; subsequent reads from the read half of the pipe will return no bytes and the error err, or EOF if err is nil.

CloseWithError never overwrites the previous error if it exists and always returns nil.

func (*Writer) SetDeadline

func (w *Writer) SetDeadline(t time.Time)

func (*Writer) Write

func (w *Writer) Write(data []byte) (n int, err error)

Write implements the standard Write interface: it writes data to the pipe, blocking until one or more readers have consumed all the data or the read end is closed. If the read end is closed with an error, that err is returned as err; otherwise err is ErrClosedPipe.