pipe

Documentation

Index

• type Pipe
  • func NewPipe() *Pipe
  • func (p *Pipe) BreakWithError(err error)
  • func (p *Pipe) CloseWithError(err error)
  • func (p *Pipe) Done() <-chan struct{}
  • func (p *Pipe) Err() error
  • func (p *Pipe) Len() int
  • func (p *Pipe) Read(d []byte) (n int, err error)
  • func (p *Pipe) Write(d []byte) (n int, err error)

Types

type Pipe

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

Pipe is a goroutine-safe io.Reader/io.Writer pair. It's like io.Pipe except there are no PipeReader/PipeWriter halves, and the underlying buffer is an interface. (io.Pipe is always unbuffered)

func NewPipe

func NewPipe() *Pipe

func (*Pipe) BreakWithError

func (p *Pipe) BreakWithError(err error)

BreakWithError causes the next Read (waking up a current blocked Read if needed) to return the provided err immediately, without waiting for unread data.

func (*Pipe) CloseWithError

func (p *Pipe) CloseWithError(err error)

CloseWithError causes the next Read (waking up a current blocked Read if needed) to return the provided err after all data has been read.

The error must be non-nil.

func (*Pipe) Done

func (p *Pipe) Done() <-chan struct{}

Done returns a channel which is closed if and when this pipe is closed with CloseWithError.

func (*Pipe) Err

func (p *Pipe) Err() error

Err returns the error (if any) first set by BreakWithError or CloseWithError.

func (*Pipe) Len

func (p *Pipe) Len() int

func (*Pipe) Read

func (p *Pipe) Read(d []byte) (n int, err error)

Read waits until data is available and copies bytes from the buffer into p.

func (*Pipe) Write

func (p *Pipe) Write(d []byte) (n int, err error)

Write copies bytes from p into the buffer and wakes a reader. It is an error to write more data than the buffer can hold.