GODRIVER-3071 Correct uint Encoding BSON Documentation #1500
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
prestonvasquez
requested review from
matthewdale
and removed request for
a team
API Change ReportNo changes found! |
matthewdale
reviewed
Dec 29, 2023
bson/doc.go
Outdated
Comment on lines
73
to
75
| // 6. When encoding with EncodeContext.MinSize set to true, uint, uint32, and uint64 will marshal to a BSON int32 if | ||
| // the value falls within the inclusive range of math.MinInt32 to math.MaxInt32. Otherwise, they will marshal to a | ||
| // BSON int64. See Encoder examples for usage of EncodeContext.MinSize. |
There was a problem hiding this comment.
EncodeContext.MinSize is deprecated, so we shouldn't recommend that people use it. They should use Encoder.IntMinSize instead.
matthewdale
reviewed
Jan 3, 2024
Co-authored-by: Matt Dale <[email protected]>
Co-authored-by: Matt Dale <[email protected]>
blink1073
pushed a commit
to blink1073/mongo-go-driver
that referenced
this pull request
Jan 13, 2024
Co-authored-by: Matt Dale <[email protected]> (cherry picked from commit 6740ce0)
qingyang-hu
pushed a commit
that referenced
this pull request
Feb 12, 2024
Co-authored-by: Matt Dale <[email protected]>
This was referenced Mar 4, 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.
GODRIVER-3071
Summary
Update documentation for when the Go Driver will marshal Go integer values (int, int8, int16, int32, int64, uint, uint8, uint16, uint32, or uint64) as the minimum BSON int size (either 32 or 64 bits) that can represent the integer value.
Background & Motivation
A user submitted this community issue describing how the Go Driver does not work as described in the following documentation:
The logic for this, added in GODRIVER-1358, is contradictory. The default case for the "min int" condition in the UintCodec is false / nil, which means that an type >= 32-bits will be considered int64. This can also be effected by EncodeContext.MinSize.