1
0
mirror of https://github.com/golang/go synced 2024-09-24 01:20:13 -06:00

io: clarify Reader returning 0, nil

Fixes #8317.

LGTM=bradfitz
R=bradfitz, iant, r
CC=golang-codereviews
https://golang.org/cl/143100043
This commit is contained in:
Russ Cox 2014-09-16 10:01:28 -04:00
parent 337fe4134f
commit 3d2321f639

View File

@ -62,8 +62,11 @@ var ErrNoProgress = errors.New("multiple Read calls return no data or error")
// allowed EOF behaviors.
//
// Implementations of Read are discouraged from returning a
// zero byte count with a nil error, and callers should treat
// that situation as a no-op. Implementations must not retain p.
// zero byte count with a nil error, except when len(p) == 0.
// Callers should treat a return of 0 and nil as indicating that
// nothing happened; in particular it does not indicate EOF.
//
// Implementations must not retain p.
type Reader interface {
Read(p []byte) (n int, err error)
}