pipe

Documentation

Overview

Package pipe provides a wrapper to create a pipe and collect at most max bytes from the reader side

Index

• func NewPipe(writer io.Writer, n int64) (<-chan struct{}, *os.File, error)
• type Buffer
  • func NewBuffer(max int64) (*Buffer, error)
  • func (b Buffer) String() string

Functions

func NewPipe

func NewPipe(writer io.Writer, n int64) (<-chan struct{}, *os.File, error)

NewPipe create a pipe with a goroutine to copy its read-end to writer returns the write end and signal for finish caller need to close w

Types

type Buffer

type Buffer struct {
	W      *os.File
	Buffer *bytes.Buffer
	Done   <-chan struct{}
	Max    int64
}

Buffer is used to create a writable pipe and read at most max bytes to a buffer

func NewBuffer

func NewBuffer(max int64) (*Buffer, error)

NewBuffer creates a os pipe, caller need to caller need to close w Notice: if rely on done for finish, w need be closed in parent process

func (Buffer) String

func (b Buffer) String() string