GODRIVER-2866 Update method signatures of bson.ValueMarshaler/bson.ValueUnmarshaler to only use basic types.
#1671
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
….ValueUnmarshaler` to only use basic types.
API Change Report./bsonincompatible changes(*D).UnmarshalJSON: removed |
matthewdale
reviewed
Jun 11, 2024
bson/marshal.go
Outdated
| @@ -34,7 +34,7 @@ type Marshaler interface { | |||
| // create custom BSON marshaling behavior for an entire BSON document, implement | |||
| // the Marshaler interface instead. | |||
| type ValueMarshaler interface { | |||
| MarshalBSONValue() (Type, []byte, error) | |||
| MarshalBSONValue() (byte, []byte, error) | |||
There was a problem hiding this comment.
Optional: Consider adding named returns to the interface to describe what the values are, since we're removing some type information. We may also want to update the documentation.
Suggested change
| MarshalBSONValue() (byte, []byte, error) | |
| MarshalBSONValue() (typ byte, data []byte, err error) |
bson/unmarshal.go
Outdated
| @@ -31,7 +31,7 @@ type Unmarshaler interface { | |||
| // document. To create custom BSON unmarshaling behavior for an entire BSON | |||
| // document, implement the Unmarshaler interface instead. | |||
| type ValueUnmarshaler interface { | |||
| UnmarshalBSONValue(Type, []byte) error | |||
| UnmarshalBSONValue(byte, []byte) error | |||
There was a problem hiding this comment.
Optional: Consider adding named parameters to the interface to describe what the values are, since we're removing some type information. We may also want to update the documentation.
Suggested change
| UnmarshalBSONValue(byte, []byte) error | |
| UnmarshalBSONValue(typ byte, data []byte) error |
prestonvasquez
approved these changes
Jun 27, 2024
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.
GODRIVER-2866
Summary
Update method signatures of
bson.ValueMarshaler/bson.ValueUnmarshalerto only use basic types.