Documentation
¶
Index ¶
- func Close(closer io.Closer)
- func CloseAll[T io.Closer](closers ...T)
- 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)
- func TryClose(resource interface{})
- func TryCloseAll[T any](resources ...T)
- type LineReader
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func Close ¶
Close a resource, and ignore error. Useful for avoiding warning when use with defer: defer iox.Close(r)
func ForEachLine ¶
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
ForEachLineWithEncoding 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 ReadAllLines ¶
ReadAllLines read all data as string lines, till EOF, return a lines slice. The reader will be left unclosed
func ReadAllLinesWithEncoding ¶
ReadAllLinesWithEncoding read all data as string line with specific encoding till EOF, return a lines slice. The reader will be left unclosed
func ReadAllString ¶
ReadAllString read and return all data as string in reader
func ReadAllStringWithEncoding ¶
ReadAllStringWithEncoding read and return all data as string in reader, with encoding the data used
func TryClose ¶
func TryClose(resource interface{})
TryClose close a resource, if the resource is an io.Closer. If close return an error, the error is ignored.
func TryCloseAll ¶
func TryCloseAll[T any](resources ...T)
TryCloseAll try close multi resources, if it is a closer
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 every line from the reader, and call consume function. 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)
ReadAllLines read all lines from the reader. return 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.
Source Files
Directories