1
0
mirror of https://github.com/golang/go synced 2024-11-19 02:04:42 -07:00

archive/tar: document Reader.Next's behavior at the end

Change-Id: I72f6d0fc66dbee3f832d2d960b99a166a5bb10c3
Reviewed-on: https://go-review.googlesource.com/2191
Reviewed-by: David Symonds <dsymonds@golang.org>
This commit is contained in:
Brad Fitzpatrick 2014-12-29 22:28:02 -08:00
parent 7e56eeeced
commit f005d6e34a

View File

@ -85,6 +85,8 @@ const (
func NewReader(r io.Reader) *Reader { return &Reader{r: r} } func NewReader(r io.Reader) *Reader { return &Reader{r: r} }
// Next advances to the next entry in the tar archive. // Next advances to the next entry in the tar archive.
//
// io.EOF is returned at the end of the input.
func (tr *Reader) Next() (*Header, error) { func (tr *Reader) Next() (*Header, error) {
var hdr *Header var hdr *Header
if tr.err == nil { if tr.err == nil {