pipe

Documentation

Index

• Variables
• func Pipe() (*Reader, *Writer)
• type Reader
  • func (r *Reader) Close()
  • func (r *Reader) ReadAll() chan interface{}
• type Writer
  • func (w *Writer) Close()
  • func (w *Writer) Write(item interface{}) error

Variables

var ErrClosedPipe = errors.New("pipe: write on closed pipe")

ErrClosedPipe will occur when manipulating an already closed pipe

Functions

func Pipe

func Pipe() (*Reader, *Writer)

Pipe creates a synchronous in-memory pipe.

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
}

Reader reads real data

func (*Reader) Close

func (r *Reader) Close()

Close closes the reader; subsequent writes to the

func (*Reader) ReadAll

func (r *Reader) ReadAll() chan interface{}

ReadAll returns the data chan. The caller should use it as `for r := range pr.ReadAll()`

type Writer

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

Writer writes real data

func (*Writer) Close

func (w *Writer) Close()

Close closes the writer; subsequent ReadAll from the read half of the pipe will return a closed channel.

func (*Writer) Write

func (w *Writer) Write(item interface{}) error

Write writes the item to the underlying data stream. It returns ErrClosedPipe when the data stream is closed.