xio

Documentation

Overview

Package xio provides i/o utilities.

Index

• func CloseIgnoringErrors(closer io.Closer)
• func ContextSleep(ctx context.Context, waitTime time.Duration) error
• func DiscardAndCloseIgnoringErrors(rc io.ReadCloser)
• func RetrieveData(filePathOrURL string) ([]byte, error)
• func RetrieveDataFromURL(urlStr string) ([]byte, error)
• func RetrieveDataFromURLWithContext(ctx context.Context, urlStr string) ([]byte, error)
• func RetrieveDataWithContext(ctx context.Context, filePathOrURL string) ([]byte, error)
• type LineWriter
  • func NewLineWriter(out func([]byte)) *LineWriter
  • func (w *LineWriter) Close() error
  • func (w *LineWriter) Write(data []byte) (n int, err error)
• type TeeWriter
  • func (t *TeeWriter) Write(p []byte) (n int, err error)

Functions

func CloseIgnoringErrors

func CloseIgnoringErrors(closer io.Closer)

CloseIgnoringErrors closes the closer and ignores any error it might produce. Should only be used for read-only streams of data where closing should never cause an error.

func ContextSleep

func ContextSleep(ctx context.Context, waitTime time.Duration) error

ContextSleep sleeps for the specified time, or until the context is done. You can check the return error to see if the context deadline was exceeded by using errors.Is(err, context.DeadlineExceeded).

func DiscardAndCloseIgnoringErrors

func DiscardAndCloseIgnoringErrors(rc io.ReadCloser)

DiscardAndCloseIgnoringErrors reads any content remaining in the body and discards it, then closes the body.

func RetrieveData

func RetrieveData(filePathOrURL string) ([]byte, error)

RetrieveData loads the bytes from the given file path or URL of type file, http, or https.

func RetrieveDataFromURL

func RetrieveDataFromURL(urlStr string) ([]byte, error)

RetrieveDataFromURL loads the bytes from the given URL of type file, http, or https.

func RetrieveDataFromURLWithContext

func RetrieveDataFromURLWithContext(ctx context.Context, urlStr string) ([]byte, error)

RetrieveDataFromURLWithContext loads the bytes from the given URL of type file, http, or https.

func RetrieveDataWithContext

func RetrieveDataWithContext(ctx context.Context, filePathOrURL string) ([]byte, error)

RetrieveDataWithContext loads the bytes from the given file path or URL of type file, http, or https.

Types

type LineWriter

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

LineWriter buffers its input into lines before sending each line to an output function without the trailing line feed.

func NewLineWriter

func NewLineWriter(out func([]byte)) *LineWriter

NewLineWriter creates a new LineWriter.

func (*LineWriter) Close

func (w *LineWriter) Close() error

Close implements the io.Closer interface.

func (*LineWriter) Write

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

Write implements the io.Writer interface.

type TeeWriter

type TeeWriter struct {
	Writers []io.Writer
}

TeeWriter is a writer that writes to multiple other writers.

func (*TeeWriter) Write

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

Write to each of the underlying streams.