Join GitHub today
GitHub is home to over 40 million developers working together to host and review code, manage projects, and build software together.Sign up
os: document behavior of IsNotExist, IsExist, etc. for nil errors #31065
The IsNotExist, IsExist, IsPermission and IsTimeout functions in package os all return false when passed a nil error, but the documentation isn't too clear about that. I presume the behavior is intentional, since there are tests for it (except for IsTimeout?). Being able to rely on this property would be nice, as it allows one to write code like the following, to treat such errors specially:
I think the root of the issue is that the term "the error" in these functions' docs is ambiguous - it could mean an error value (which can be nil) or an error condition (which is represented by a non-nil error value).
I was just about to write exactly this bug report, because I just found some code which was convoluted enough to trip up a linter because it was trying to avoid calling IsNotExist on a nil. Intuitively, I would prefer to get the false answer rather than a panic, because it is not the case that a nil is an error which represents a file not existing.