mirror
/
go
mirror of https://github.com/golang/go.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

bufio: document ReadFrom/WriteTo calls to underlying methods 

In general use of these magic methods must be documented so that
users understand what will happen.

Fixes #23289

Change-Id: Ic46915eee1d3b7e57d8d1886834ddfb2e8e66e62
Reviewed-on: https://go-review.googlesource.com/103238
Reviewed-by: Rob Pike <r@golang.org>
This commit is contained in:
Ian Lance Taylor 2018-03-28 14:42:05 -07:00
parent 2f14fc9c68
commit c53ff2818a
1 changed files with 5 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
src/bufio/bufio.go
View File

@ -462,6 +462,8 @@ func (b *Reader) ReadString(delim byte) (string, error) {
// WriteTo implements io.WriterTo. // WriteTo implements io.WriterTo.
// This may make multiple calls to the Read method of the underlying Reader. // This may make multiple calls to the Read method of the underlying Reader.
// If the underlying reader supports the WriteTo method,
// this calls the underlying WriteTo without buffering.
func (b *Reader) WriteTo(w io.Writer) (n int64, err error) { func (b *Reader) WriteTo(w io.Writer) (n int64, err error) {
n, err = b.writeBuf(w) n, err = b.writeBuf(w)
if err != nil { if err != nil {
@ -684,7 +686,9 @@ func (b *Writer) WriteString(s string) (int, error) {
return nn, nil return nn, nil
} }
// ReadFrom implements io.ReaderFrom. // ReadFrom implements io.ReaderFrom. If the underlying writer
// supports the ReadFrom method, and b has no buffered data yet,
// this calls the underlying ReadFrom without buffering.
func (b *Writer) ReadFrom(r io.Reader) (n int64, err error) { func (b *Writer) ReadFrom(r io.Reader) (n int64, err error) {
if b.Buffered() == 0 { if b.Buffered() == 0 {
if w, ok := b.wr.(io.ReaderFrom); ok { if w, ok := b.wr.(io.ReaderFrom); ok {