Allow visit function to return errors in structwalk.WalkType #3034
Conversation
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
denik
reviewed
Jun 11, 2025
libs/structwalk/walktype.go
Outdated
| @@ -27,7 +27,9 @@ import ( | |||
| // | |||
| // ****************************************************************************************************** | |||
|
|
|||
| type VisitTypeFunc func(path *structpath.PathNode, typ reflect.Type) | |||
| type VisitTypeFunc func(path *structpath.PathNode, typ reflect.Type) error | |||
There was a problem hiding this comment.
Can this be simpler? We don't care about errors, just need skipping, so we can return bool: true to continue, false to skip.
The error propagation can really be done by the caller however they like (e.g. append diagnostics), no need to complicate visit logic.
There was a problem hiding this comment.
Fair enough, I've updated the function to return a boolean. I flipped the semantics though because skipping on true seemed cleaner.
denik
reviewed
Jun 11, 2025
denik
reviewed
Jun 11, 2025
denik
approved these changes
Jun 11, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Changes
This PR:
ErrSkipWalkwhich can be returned by a skip function to skip walking that type entirely.Why
This is needed for required code-generation because we wish to avoid walking some internal structs like like Locations where otherwise we end up consider fields in it as required.
Tests
New unit tests.