Files
dolt/go/libraries/utils/iohelp/read.go

81 lines
2.5 KiB
Go

// Copyright 2019 Dolthub, Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package iohelp
import (
"bufio"
"io"
)
// ErrPreservingReader is a utility class that provides methods to read from a reader where errors can be ignored and
// handled later. Once an error occurs subsequent calls to read won't pull data from the io.Reader, will be a noop, and
// the initial error can be retrieved from Err at any time. ErrPreservingReader implements the io.Reader interface
// itself so it can be used as any other Reader would be.
type ErrPreservingReader struct {
// R is the reader supplying the actual data.
R io.Reader
// Err is the first error that occurred, or nil
Err error
}
// NewErrPreservingReader creates a new instance of an ErrPreservingReader
func NewErrPreservingReader(r io.Reader) *ErrPreservingReader {
return &ErrPreservingReader{r, nil}
}
// Read reads data from the underlying io.Reader if no previous errors have occurred. If an error has already occurred
// then read will simply no-op and return 0 for the number of bytes read and the original error.
func (r *ErrPreservingReader) Read(p []byte) (int, error) {
n := 0
if r.Err == nil {
n, r.Err = r.R.Read(p)
}
return n, r.Err
}
// ReadLine will read a line from an unbuffered io.Reader where it considers lines to be separated by newlines (\n).
// The data returned will be a string with \r\n characters removed from the end, a bool which says whether the end of
// the stream has been reached, and any errors that have been encountered (other than eof which is treated as the end of
// the final line)
func ReadLine(br *bufio.Reader) (line string, done bool, err error) {
line, err = br.ReadString('\n')
if err != nil {
if err != io.EOF {
return "", true, err
}
}
crlfCount := 0
lineLen := len(line)
for i := lineLen - 1; i >= 0; i-- {
ch := line[i]
if ch == '\r' || ch == '\n' {
crlfCount++
} else {
break
}
}
return line[:lineLen-crlfCount], err != nil, nil
}