mirror of
https://github.com/golang/go
synced 2024-11-23 11:10:04 -07:00
filepath: updates doc to give case where WalkFunc info arg may be nil
If a filepath.WalkFunc is called with an non-nil err argument, it's possible
that the info argument will be nil. The comment above filepath.WalkFunc now
reflects this.
Fixes #26425
Change-Id: Ib9963b3344587d2993f1698c5a801f2d1286856b
GitHub-Last-Rev: 553fc266b5
GitHub-Pull-Request: golang/go#26435
Reviewed-on: https://go-review.googlesource.com/124635
Reviewed-by: Ian Lance Taylor <iant@golang.org>
This commit is contained in:
parent
d2f663c4f2
commit
4016de0daf
@ -341,12 +341,13 @@ var SkipDir = errors.New("skip this directory")
|
||||
//
|
||||
// If there was a problem walking to the file or directory named by path, the
|
||||
// incoming error will describe the problem and the function can decide how
|
||||
// to handle that error (and Walk will not descend into that directory). If
|
||||
// an error is returned, processing stops. The sole exception is when the function
|
||||
// returns the special value SkipDir. If the function returns SkipDir when invoked
|
||||
// on a directory, Walk skips the directory's contents entirely.
|
||||
// If the function returns SkipDir when invoked on a non-directory file,
|
||||
// Walk skips the remaining files in the containing directory.
|
||||
// to handle that error (and Walk will not descend into that directory). In the
|
||||
// case of an error, the info argument will be nil. If an error is returned,
|
||||
// processing stops. The sole exception is when the function returns the special
|
||||
// value SkipDir. If the function returns SkipDir when invoked on a directory,
|
||||
// Walk skips the directory's contents entirely. If the function returns SkipDir
|
||||
// when invoked on a non-directory file, Walk skips the remaining files in the
|
||||
// containing directory.
|
||||
type WalkFunc func(path string, info os.FileInfo, err error) error
|
||||
|
||||
var lstat = os.Lstat // for testing
|
||||
|
Loading…
Reference in New Issue
Block a user