1
0
mirror of https://github.com/golang/go synced 2024-09-29 04:14:27 -06:00

os: document that NewFile can return nil

Fixes #20023

Change-Id: I1bec3e69031ffcfd7ad71716be9597ec322528ff
Reviewed-on: https://go-review.googlesource.com/41211
Reviewed-by: Russ Cox <rsc@golang.org>
This commit is contained in:
Alberto Donizetti 2017-04-20 11:13:55 +02:00
parent 2d1829b539
commit 9a432552cb
3 changed files with 9 additions and 3 deletions

View File

@ -35,7 +35,9 @@ func (f *File) Fd() uintptr {
return uintptr(f.fd)
}
// NewFile returns a new File with the given file descriptor and name.
// NewFile returns a new File with the given file descriptor and
// name. The returned value will be nil if fd is not a valid file
// descriptor.
func NewFile(fd uintptr, name string) *File {
fdi := int(fd)
if fdi < 0 {

View File

@ -59,7 +59,9 @@ func (f *File) Fd() uintptr {
return uintptr(f.pfd.Sysfd)
}
// NewFile returns a new File with the given file descriptor and name.
// NewFile returns a new File with the given file descriptor and
// name. The returned value will be nil if fd is not a valid file
// descriptor.
func NewFile(fd uintptr, name string) *File {
return newFile(fd, name, false)
}

View File

@ -64,7 +64,9 @@ func newConsoleFile(h syscall.Handle, name string) *File {
return newFile(h, name, "console")
}
// NewFile returns a new File with the given file descriptor and name.
// NewFile returns a new File with the given file descriptor and
// name. The returned value will be nil if fd is not a valid file
// descriptor.
func NewFile(fd uintptr, name string) *File {
h := syscall.Handle(fd)
if h == syscall.InvalidHandle {