export sentinel errors so callers can use errors.Is#27
Open
c-tonneslan wants to merge 2 commits into
Open
Conversation
Per the maintainer's note in fatih#24, the package-level error variables were unexported, so callers had to do string-compare on the error message to handle 'tag not found' specifically. Promote them to ErrXxx and keep the lowercase aliases pointing at the exported ones so existing call sites compile unchanged. Closes fatih#24 Signed-off-by: Charlie Tonneslan <cst0520@gmail.com>
Owner
|
I think you can just export them, it wouldn't break anything. |
Per @fatih's review note - the aliases aren't needed, just exporting the sentinels in place doesn't break anything because they're only used inside the package. Renamed the call sites in tags.go and tags_test.go to match. Signed-off-by: Charlie Tonneslan <cst0520@gmail.com>
Author
|
Good point, done. Dropped the aliases and renamed the internal call sites in tags.go and tags_test.go. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #24.
Per @fatih's note on the issue, the sentinel errors were unexported, so callers were stuck doing string-compare on the message to handle a 'tag not found' specifically. Promote them to `ErrXxx` and keep the lowercase names as aliases so the internal call sites compile unchanged.
Lets users write:
```go
tag, err := tags.Get("json")
switch {
case errors.Is(err, structtag.ErrTagNotExist):
...
case err != nil:
...
}
```