Drop Options argument from user-declared methods and functions #163
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 contains breaking changes. This drops Options as an argument from the MarshalerTo and UnmarshalerFrom interfaces and the MarshalToFunc and UnmarshalFromFunc functions. Instead, the options is stored within the jsontext.Encoder or jsontext.Decoder and can be retrieved through the Options method. This simplifies the API for custom marshalers and unmarshalers and makes it impossible to accidentally drop the options when recursively calling json.MarshalEncode or json.UnmarshalDecode from within a custom marshaler or unmarshaler implementation. Fixes golang/go#71611
dsnet
commented
Feb 13, 2025
| return nil | ||
| } | ||
|
|
||
| var structOptionsPool = &sync.Pool{New: func() any { return new(jsonopts.Struct) }} |
There was a problem hiding this comment.
Yay! We get to delete one of the pools.
dsnet
commented
Feb 13, 2025
| @@ -544,6 +511,9 @@ func newAddressableValue(t reflect.Type) addressableValue { | |||
| return addressableValue{reflect.New(t).Elem(), true} | |||
| } | |||
|
|
|||
| // TODO: Remove *jsonopts.Struct argument from [marshaler] and [unmarshaler]. | |||
There was a problem hiding this comment.
I suspect this will speed up the performance of marshaling and unmarshaling since each recursive call doesn't need to keep passing the same *Struct pointer on the stack.
johanbrandhorst
approved these changes
Feb 13, 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.
WARNING: This commit contains breaking changes.
This drops Options as an argument from
the MarshalerTo and UnmarshalerFrom interfaces and the MarshalToFunc and UnmarshalFromFunc functions.
Instead, the options is stored within the
jsontext.Encoder or jsontext.Decoder and
can be retrieved through the Options method.
This simplifies the API for custom marshalers and unmarshalers and makes it impossible to accidentally drop the options when recursively calling json.MarshalEncode or json.UnmarshalDecode from within a custom marshaler or unmarshaler implementation.
Fixes golang/go#71611