Use constructors for static tokens #29
Open
Conversation
This file contains 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
WARNING: This commit includes breaking changes. Instead of global variables, use function constructors for static tokens such as Null, ObjectStart, ObjectEnd, ArrayStart, and ArrayEnd. This provides a greater degree of immutability for the API. Note that static tokens for True and False are dropped in favor of the pre-existing Bool constructor. If necessary, we can already re-introduce True and False.
mvdan
approved these changes
Apr 12, 2024
|
One advantage of this is that it makes In godoc, variables are given less prominence than functions (e.g., variables never show up in the table of contents, while functions do). |
johanbrandhorst
approved these changes
Apr 12, 2024
|
I think it is fine. We did the same thing for "constant" values in go-kit/log/level. https://github.com/go-kit/log/blob/0b69c7049332e99c25d5fd0f4d08317cfe45e7d8/level/level.go#L204-L239 |
|
SGTM with the assumption the compiler is/will be clever enough to handle this efficiently |
|
I prefer the old scheme. If it's for immutability, can we set these enums to const string and expose the rawToken helper function? |
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.
WARNING: This commit includes breaking changes.
Instead of global variables, use function constructors for static tokens such as Null, ObjectStart, ObjectEnd, ArrayStart, and ArrayEnd. This provides a greater degree of immutability for the API.
Note that static tokens for True and False are dropped in favor of the pre-existing Bool constructor.
If necessary, we can always re-introduce True and False.