diff options
author | Russ Cox <rsc@golang.org> | 2016-10-26 12:22:16 -0400 |
---|---|---|
committer | Russ Cox <rsc@golang.org> | 2016-10-28 19:38:12 +0000 |
commit | 30651b3bbbfda86e8188dfd89cb326a4db085e25 (patch) | |
tree | 646b501df3e68203d6fbe1a2bfe0be10d998d2f3 /src/encoding/csv | |
parent | e2bcae7875e37c13f92dc3cf16614bf7e70fa6c8 (diff) | |
download | go-30651b3bbbfda86e8188dfd89cb326a4db085e25.tar.gz go-30651b3bbbfda86e8188dfd89cb326a4db085e25.zip |
encoding/csv: document Read error behavior
Fixes #17342.
Change-Id: I76af756d7aff464554c5564d444962a468d0eccc
Reviewed-on: https://go-review.googlesource.com/32172
Run-TryBot: Russ Cox <rsc@golang.org>
Reviewed-by: Quentin Smith <quentin@golang.org>
Diffstat (limited to 'src/encoding/csv')
-rw-r--r-- | src/encoding/csv/reader.go | 8 |
1 files changed, 6 insertions, 2 deletions
diff --git a/src/encoding/csv/reader.go b/src/encoding/csv/reader.go index 28caa6aa27..c8c4ca7758 100644 --- a/src/encoding/csv/reader.go +++ b/src/encoding/csv/reader.go @@ -141,8 +141,12 @@ func (r *Reader) error(err error) error { } } -// Read reads one record from r. The record is a slice of strings with each -// string representing one field. +// Read reads one record (a slice of fields) from r. +// If the record has an unexpected number of fields, +// Read returns the record along with the error ErrFieldCount. +// Except for that case, Read always returns either a non-nil +// record or a non-nil error, but not both. +// If there is no data left to be read, Read returns nil, io.EOF. func (r *Reader) Read() (record []string, err error) { for { record, err = r.parseRecord() |