pio

package
v0.4.112 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Oct 12, 2023 License: ISC Imports: 12 Imported by: 0

Documentation

Overview

EofReader is an empty reader returning EOF. Thread-safe

LineReader reads a stream one line per Read invocation.

LineReader reads a stream one line per Read invocation.

ReadWriteCloserSlice is a read-writer with a slice as intermediate storage. thread-safe.

TeeWriter is a writer that copies its writes to one or more other writers.

Index

Constants

This section is empty.

Variables

View Source 
var EofReader io.Reader = &eofReader{}

EofReader is an empty reader returning EOF. Thread-safe

View Source 
var ErrFileAlreadyClosed = errors.New("file alread closed")

On write after close, ErrFileAlreadyClosed is returned. 

if errors.Is(err, pio.ErrFileAlreadyClosed)…
View Source 
var ErrInvalidWrite = errors.New("invalid write result")

errInvalidWrite means that a write returned an impossible count.

Functions

func CopyContext added in v0.4.108 

func CopyContext(dst io.Writer, src io.Reader, buf []byte, ctx context.Context) (written int64, err error)

CopyContext is like io.Copy but is cancelable via context

  • CopyContext closes both reader and writer if they are closable
  • to cancel a read or write in progress, the reader must be closable

func CopyThread added in v0.4.95 

func CopyThread(
	label string, reader io.Reader, writer io.Writer,
	errCh chan<- error, ctx context.Context,
)

CopyThread copies from an io.Reader to an io.Writer.

  • label is used for thread identification on panics
  • errCh receives result and makes thread awaitable
  • if ctx, a CancelContext, is non-nil and error occurs, ctx is cancelled
  • CopyThread itself never fails

func InitWriteCloserToChan 

func InitWriteCloserToChan(wcp *WriteCloserToChan)

func NewReadCloserCallbacker added in v0.4.38 

func NewReadCloserCallbacker(closeCallback func(err error) (e error), readCloser io.ReadCloser) (readCloserCallbacker io.ReadCloser)

func NewTeeWriter added in v0.4.38 

func NewTeeWriter(closeCallback func() (err error), writers ...io.Writer) (teeWriter io.WriteCloser)

TeeWriter is a writer that copies its writes to one or more other writers.

func NewWriteCloserCallbacker added in v0.4.38 

func NewWriteCloserCallbacker(closeCallback func(err error) (e error), writeCloser io.WriteCloser) (writeCloserCallbacker io.WriteCloser)

func NewWriteCloserToChan 

func NewWriteCloserToChan() (writeCloser io.WriteCloser)

func NewWriteCloserToChanLine 

func NewWriteCloserToChanLine(withNewline ...bool) (writeCloser io.WriteCloser)

func NewWriteCloserToString 

func NewWriteCloserToString() io.WriteCloser

NewWriteCloserToString returns an io.WriteCloser that aggregates its oputput in a string. Thread-safe.

Types

type CloserCallbacker added in v0.4.38 

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

CloserCallbacker implements a close callback for io.Closer

func (*CloserCallbacker) Close added in v0.4.38 

func (cc *CloserCallbacker) Close(closer io.Closer) (err error)

func (*CloserCallbacker) IsClosed added in v0.4.38 

func (cc *CloserCallbacker) IsClosed() (isClosed bool)

func (*CloserCallbacker) Wait added in v0.4.38 

func (cc *CloserCallbacker) Wait()

type ContextCloser added in v0.4.108 

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

func NewContextCloser added in v0.4.108 

func NewContextCloser(closer io.Closer) (contextCloser *ContextCloser)

func (*ContextCloser) Close added in v0.4.108 

func (c *ContextCloser) Close() (err error)

func (*ContextCloser) IsCloseable added in v0.4.108 

func (c *ContextCloser) IsCloseable() (isCloseable bool)

type ContextCopier added in v0.4.108 

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

func NewContextCopier added in v0.4.108 

func NewContextCopier(dst io.Writer, src io.Reader, buf []byte, ctx context.Context) (copier *ContextCopier)

func (*ContextCopier) BufCopy added in v0.4.108 

func (c *ContextCopier) BufCopy() (written int64, err error)

copy using buffer

func (*ContextCopier) Close added in v0.4.108 

func (c *ContextCopier) Close(errp *error)

func (*ContextCopier) Configuration added in v0.4.108 

func (c *ContextCopier) Configuration() (
	hasCloseables,
	hasWriterTo,
	hasReaderFrom bool,
)

func (*ContextCopier) ContextThread added in v0.4.108 

func (c *ContextCopier) ContextThread()

func (*ContextCopier) ReadFrom added in v0.4.108 

func (c *ContextCopier) ReadFrom() (n int64, err error)

func (*ContextCopier) ShutdownThread added in v0.4.108 

func (c *ContextCopier) ShutdownThread(errp *error)

func (*ContextCopier) WriteTo added in v0.4.108 

func (c *ContextCopier) WriteTo() (n int64, err error)

type ContextReader added in v0.4.108 

type ContextReader struct {
	ContextCloser
	// contains filtered or unexported fields
}

func NewContextReader added in v0.4.108 

func NewContextReader(reader io.Reader, ctx context.Context) (contextReader *ContextReader)

func (*ContextReader) Read added in v0.4.108 

func (c *ContextReader) Read(p []byte) (n int, err error)

type ContextWriter added in v0.4.108 

type ContextWriter struct {
	ContextCloser
	// contains filtered or unexported fields
}

func NewContextWriter added in v0.4.108 

func NewContextWriter(writer io.Writer, ctx context.Context) (contextWriter *ContextWriter)

func (*ContextWriter) Write added in v0.4.108 

func (c *ContextWriter) Write(p []byte) (n int, err error)

type LineReader added in v0.4.38 

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

LineReader reads a stream one line per Read invocation.

func NewLineReader added in v0.4.38 

func NewLineReader(reader io.Reader) (lineReader *LineReader)

func (*LineReader) Read added in v0.4.38 

func (rr *LineReader) Read(p []byte) (n int, err error)

Read returns a byte-sequence ending with newline if size of p is sufficient.

  • if size of p is too short, the text will not end with newline
  • if EOF without newline, text has no newline and err is io.EOF

func (*LineReader) ReadLine added in v0.4.38 

func (rr *LineReader) ReadLine(p []byte) (line []byte, isEOF bool, err error)

ReadLine returns full lines, extending p as necessary

  • len(line) is number of bytes
  • max line length 1 MiB
  • line will end with newLine unless 1 MiB or isEOF
  • EOF is returned as isEOF true

type LineWriter added in v0.4.38 

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

func NewLineWriter added in v0.4.38 

func NewLineWriter(writeCloser io.WriteCloser,
	filter func(line *[]byte, isLastLine bool) (skipLine bool, err error)) (lineWriter *LineWriter)

func (*LineWriter) Close added in v0.4.38 

func (wc *LineWriter) Close() (err error)

Close closes

func (*LineWriter) Write added in v0.4.38 

func (wc *LineWriter) Write(p []byte) (n int, err error)

Write saves data in slice and returns all bytes written or ErrFileAlreadyClosed

type ReadCloserCallbacker added in v0.4.38 

type ReadCloserCallbacker struct {
	io.ReadCloser
	CloserCallbacker
}

func (*ReadCloserCallbacker) Close added in v0.4.38 

func (cc *ReadCloserCallbacker) Close() (err error)

type ReadWriteCloserSlice 

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

ReadWriteCloserSlice is a read-writer with a slice as intermediate storage. thread-safe.

  • Close closes the writer side indicating no further data will be added
  • Write and Close may return error that can be checked: errors.Is(err, pio.ErrFileAlreadyClosed)
  • read will eventually return io.EOF after a Close
  • there are no other errors

func NewReadWriteCloserSlice 

func NewReadWriteCloserSlice() (readWriteCloser *ReadWriteCloserSlice)

func (*ReadWriteCloserSlice) Buffer added in v0.4.95 

func (r *ReadWriteCloserSlice) Buffer() (buffer []byte)

func (*ReadWriteCloserSlice) Close 

func (r *ReadWriteCloserSlice) Close() (err error)

Close closes thw Write part, may return ErrFileAlreadyClosed

func (*ReadWriteCloserSlice) Read 

func (r *ReadWriteCloserSlice) Read(p []byte) (n int, err error)

Read returns at most len(p) bytes read in n and possibly io.EOF

  • Read is blocking
  • n may be less than len(p)
  • if len(p) > 0, non-error return will have n > 0

func (*ReadWriteCloserSlice) Write 

func (r *ReadWriteCloserSlice) Write(p []byte) (n int, err error)

Write saves data in slice and returns all bytes written or ErrFileAlreadyClosed

type TeeWriter added in v0.4.38 

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

TeeWriter is a writer that copies its writes to one or more other writers.

func (*TeeWriter) Close added in v0.4.38 

func (tw *TeeWriter) Close() (err error)

func (*TeeWriter) Write added in v0.4.38 

func (tw *TeeWriter) Write(p []byte) (n int, err error)

type WriteCloserCallbacker added in v0.4.38 

type WriteCloserCallbacker struct {
	io.WriteCloser
	CloserCallbacker
}

func (*WriteCloserCallbacker) Close added in v0.4.38 

func (cc *WriteCloserCallbacker) Close() (err error)

type WriteCloserToChan 

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

func (*WriteCloserToChan) Ch 

func (wc *WriteCloserToChan) Ch() (readCh <-chan []byte)

func (*WriteCloserToChan) Close 

func (wc *WriteCloserToChan) Close() (err error)

func (*WriteCloserToChan) Write 

func (wc *WriteCloserToChan) Write(p []byte) (n int, err error)

type WriteCloserToChanLine 

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

func (*WriteCloserToChanLine) Ch 

func (wc *WriteCloserToChanLine) Ch() (readCh <-chan string)

func (*WriteCloserToChanLine) Close 

func (wc *WriteCloserToChanLine) Close() (err error)

func (*WriteCloserToChanLine) Write 

func (wc *WriteCloserToChanLine) Write(p []byte) (n int, err error)

type WriteCloserToString 

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

WriteCloserToString is an io.WriteCloser that aggregates its oputput in a string. Thread-safe.

  • the string is available using the Data method.

func (*WriteCloserToString) Close 

func (wc *WriteCloserToString) Close() (err error)

Close should only be invoked once. Close is not required for releasing resources.

func (*WriteCloserToString) Data 

func (wc *WriteCloserToString) Data() (s string)

Data returns current string data

func (*WriteCloserToString) Write 

func (wc *WriteCloserToString) Write(p []byte) (n int, err error)

Write always succeeds

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.