Commit c8423f90 authored by Brad Fitzpatrick's avatar Brad Fitzpatrick

io: document ReaderFrom and WriterTo

Fixes #3711

R=golang-dev, adg
CC=golang-dev
https://golang.org/cl/6445083
parent b3caa2ba
...@@ -130,11 +130,23 @@ type ReadWriteSeeker interface { ...@@ -130,11 +130,23 @@ type ReadWriteSeeker interface {
} }
// ReaderFrom is the interface that wraps the ReadFrom method. // ReaderFrom is the interface that wraps the ReadFrom method.
//
// ReadFrom reads data from r until EOF. The return value n is the
// number of bytes read. Any error except io.EOF encountered during
// the read is also returned.
//
// The Copy function uses ReaderFrom if available.
type ReaderFrom interface { type ReaderFrom interface {
ReadFrom(r Reader) (n int64, err error) ReadFrom(r Reader) (n int64, err error)
} }
// WriterTo is the interface that wraps the WriteTo method. // WriterTo is the interface that wraps the WriteTo method.
//
// WriteTo writes data to w until there's no more data to write or
// when an error occurs. The return value n is the number of bytes
// written. Any error encountered during the write is also returned.
//
// The Copy function uses WriterTo if available.
type WriterTo interface { type WriterTo interface {
WriteTo(w Writer) (n int64, err error) WriteTo(w Writer) (n int64, err error)
} }
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment