iox

Documentation

Index

• func Close(closer io.Closer)
• func EmptyReader() io.Reader
• func ForEachLine(r io.Reader, consume func(line string)) error
• func ForEachLineWithEncoding(r io.Reader, encoding encoding.Encoding, consume func(line string)) error
• func ReadAll(r io.Reader) ([]byte, error)
• func ReadAllLines(r io.Reader) ([]string, error)
• func ReadAllLinesWithEncoding(r io.Reader, enc encoding.Encoding) ([]string, error)
• func ReadAllString(r io.Reader) (string, error)
• func ReadAllStringWithEncoding(r io.Reader, encoding encoding.Encoding) (string, error)
• type LineReader
  • func NewLineReader(r io.Reader) *LineReader
  • func NewLineReaderSize(r io.Reader, initialSize int) *LineReader
  • func (r *LineReader) ForEachLine(consume func(line string)) error
  • func (r *LineReader) ReadAllLines() ([]string, error)
  • func (r *LineReader) ReadLine() (string, error)

Functions

func Close

func Close(closer io.Closer)

Close a resource, and ignore error. Useful for avoiding warning when use with defer: defer iox.Close(r)

func EmptyReader

func EmptyReader() io.Reader

EmptyReader return a empty reader

func ForEachLine

func ForEachLine(r io.Reader, consume func(line string)) error

ForEachLine read all lines in reader, and call consume function, The line index pass to function start from 0. If and err occurred during read, return an error. If read all data succeed till and io.EOF, nil error will be returned.

func ForEachLineWithEncoding

func ForEachLineWithEncoding(r io.Reader, encoding encoding.Encoding, consume func(line string)) error

ForEachLine read all lines in reader with specific encoding, and call consume function, The line index pass to function start from 0. If and err occurred during read, return an error. If read all data succeed till and io.EOF, nil error will be returned.

func ReadAll

func ReadAll(r io.Reader) ([]byte, error)

ReadAll read and return all data in reader

func ReadAllLines

func ReadAllLines(r io.Reader) ([]string, error)

ReadAllLines read all data as string lines, till EOF, return a lines slice. The reader will be left unclosed

func ReadAllLinesWithEncoding

func ReadAllLinesWithEncoding(r io.Reader, enc encoding.Encoding) ([]string, error)

ReadAllLinesWithEncoding read all data as string line with specific encoding till EOF, return a lines slice. The reader will be left unclosed

func ReadAllString

func ReadAllString(r io.Reader) (string, error)

ReadAllString read and return all data as string in reader

func ReadAllStringWithEncoding

func ReadAllStringWithEncoding(r io.Reader, encoding encoding.Encoding) (string, error)

ReadAllStringWithEncoding read and return all data as string in reader, with encoding the data used

Types

type LineReader

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

LineReader is a read which can read line by line, without limitation for line length.

func NewLineReader

func NewLineReader(r io.Reader) *LineReader

NewLineReader create new LineReader

func NewLineReaderSize

func NewLineReaderSize(r io.Reader, initialSize int) *LineReader

NewLineReaderSize create new LineReader with initial buf size

func (*LineReader) ForEachLine

func (r *LineReader) ForEachLine(consume func(line string)) error

ForEachLine read all lines in reader, and call consume function, The line index pass to function start from 0. If and err occurred during read, return an error. If read all data succeed till and io.EOF, nil error will be returned.

func (*LineReader) ReadAllLines

func (r *LineReader) ReadAllLines() ([]string, error)

ReadAllLine read all lines in reader, return lines, and an error if any error occurred while read. If read all data succeed till and io.EOF, nil error will be returned.

func (*LineReader) ReadLine

func (r *LineReader) ReadLine() (string, error)

ReadLine read and return one line, not including the end-of-line bytes. ReadLine either returns a non-nil line or it returns an error, never both. No indication or error is given if the input ends without a final line end. An io.EOF error would be returned if already read to the end of reader.