languages/go
languages/go
1
0
Fork 0
mirror of https://github.com/golang/go synced 2024-11-02 11:50:30 +00:00
Code Issues Projects Releases Packages Wiki Activity

io: unexport internal methods

Browse source 
The methods on the pipe type don't need to be exported. Doing so sets
a bad precedent that it's OK to export methods to indicate an internal
public API.  That's not a good idea in general, because exported methods
increase cognitive load when reading code: the reader needs to consider
whether the exported method might be used via some external interface
or reflection.

Change-Id: Ib13f1b3f9fe0ff251628f31b776182a0953268ee
Reviewed-on: https://go-review.googlesource.com/c/go/+/341409
Reviewed-by: Daniel Martí <mvdan@mvdan.cc>
Reviewed-by: Joe Tsai <thebrokentoaster@gmail.com>
Reviewed-by: Joe Tsai <joetsai@digital-static.net>
Trust: Daniel Martí <mvdan@mvdan.cc>
This commit is contained in:
Roger Peppe 2021-08-11 12:14:41 +01:00 committed by roger peppe
parent 740f7d7370
commit 3bdc1799d6
1 changed files with 26 additions and 24 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

50
src/io/pipe.go
View file

@ -47,7 +47,7 @@ type pipe struct {
werr onceError
}
func (p *pipe) Read(b []byte) (n int, err error) {
func (p *pipe) read(b []byte) (n int, err error) {
select {
case <-p.done:
return 0, p.readCloseError()
@ -64,15 +64,7 @@ func (p *pipe) Read(b []byte) (n int, err error) {
}
}
func (p *pipe) readCloseError() error {
rerr := p.rerr.Load()
if werr := p.werr.Load(); rerr == nil && werr != nil {
return werr
}
return ErrClosedPipe
}
func (p *pipe) CloseRead(err error) error {
func (p *pipe) closeRead(err error) error {
if err == nil {
err = ErrClosedPipe
}
@ -81,7 +73,7 @@ func (p *pipe) CloseRead(err error) error {
return nil
}
func (p *pipe) Write(b []byte) (n int, err error) {
func (p *pipe) write(b []byte) (n int, err error) {
select {
case <-p.done:
return 0, p.writeCloseError()
@ -103,15 +95,7 @@ func (p *pipe) Write(b []byte) (n int, err error) {
return n, nil
}
func (p *pipe) writeCloseError() error {
werr := p.werr.Load()
if rerr := p.rerr.Load(); werr == nil && rerr != nil {
return rerr
}
return ErrClosedPipe
}
func (p *pipe) CloseWrite(err error) error {
func (p *pipe) closeWrite(err error) error {
if err == nil {
err = EOF
}
@ -120,6 +104,24 @@ func (p *pipe) CloseWrite(err error) error {
return nil
}
// readCloseError is considered internal to the pipe type.
func (p *pipe) readCloseError() error {
rerr := p.rerr.Load()
if werr := p.werr.Load(); rerr == nil && werr != nil {
return werr
}
return ErrClosedPipe
}
// writeCloseError is considered internal to the pipe type.
func (p *pipe) writeCloseError() error {
werr := p.werr.Load()
if rerr := p.rerr.Load(); werr == nil && rerr != nil {
return rerr
}
return ErrClosedPipe
}
// A PipeReader is the read half of a pipe.
type PipeReader struct {
p *pipe
@ -131,7 +133,7 @@ type PipeReader struct {
// If the write end is closed with an error, that error is
// returned as err; otherwise err is EOF.
func (r *PipeReader) Read(data []byte) (n int, err error) {
return r.p.Read(data)
return r.p.read(data)
}
// Close closes the reader; subsequent writes to the
@ -146,7 +148,7 @@ func (r *PipeReader) Close() error {
// CloseWithError never overwrites the previous error if it exists
// and always returns nil.
func (r *PipeReader) CloseWithError(err error) error {
return r.p.CloseRead(err)
return r.p.closeRead(err)
}
// A PipeWriter is the write half of a pipe.
@ -160,7 +162,7 @@ type PipeWriter struct {
// If the read end is closed with an error, that err is
// returned as err; otherwise err is ErrClosedPipe.
func (w *PipeWriter) Write(data []byte) (n int, err error) {
return w.p.Write(data)
return w.p.write(data)
}
// Close closes the writer; subsequent reads from the
@ -176,7 +178,7 @@ func (w *PipeWriter) Close() error {
// CloseWithError never overwrites the previous error if it exists
// and always returns nil.
func (w *PipeWriter) CloseWithError(err error) error {
return w.p.CloseWrite(err)
return w.p.closeWrite(err)
}
// Pipe creates a synchronous in-memory pipe.