mirror of
https://github.com/golang/go
synced 2024-11-22 16:25:07 -07:00
io/fs: clarify additional File interface docs
Emphasize ReadDirFile. It isn't really optional, and all filesystems have at least one directory ("."). The remaining two additional interfaces are optimizations. Call them that. Fully qualify package package io identifiers. Change-Id: Ibc425a5dfd27e08c2c10c353f780e4a6304cfd87 Reviewed-on: https://go-review.googlesource.com/c/go/+/296390 Trust: Josh Bleecher Snyder <josharian@gmail.com> Run-TryBot: Josh Bleecher Snyder <josharian@gmail.com> TryBot-Result: Go Bot <gobot@golang.org> Reviewed-by: Ian Lance Taylor <iant@golang.org>
This commit is contained in:
parent
0a655598e1
commit
bbf79793bd
@ -73,8 +73,8 @@ func ValidPath(name string) bool {
|
||||
|
||||
// A File provides access to a single file.
|
||||
// The File interface is the minimum implementation required of the file.
|
||||
// A file may implement additional interfaces, such as
|
||||
// ReadDirFile, ReaderAt, or Seeker, to provide additional or optimized functionality.
|
||||
// Directory files should also implement ReadDirFile.
|
||||
// A file may implement io.ReaderAt or io.Seeker as optimizations.
|
||||
type File interface {
|
||||
Stat() (FileInfo, error)
|
||||
Read([]byte) (int, error)
|
||||
|
Loading…
Reference in New Issue
Block a user