refactor: replace reflect.StringHeader with unsafe.StringData
#1162
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
Closes #1147. The Godoc of `reflect.StringHeader` says [1]: "the Data field is not sufficient to guarantee the data it references will not be garbage collected, so programs must keep a separate, correctly typed pointer to the underlying data." And the Godoc of `unsafe.Pointer` says [2]: "A uintptr is an integer, not a reference. ... Even if a uintptr holds the address of some object, the garbage collector will not update that uintptr's value if the object moves, nor will that uintptr keep the object from being reclaimed." The replacement `unsafe.StringData` is a more correct way to get the pointer to the string data. The original proposal can be seen in golang/go#53003 (comment). [1]: https://pkg.go.dev/reflect#StringHeader [2]: https://pkg.go.dev/unsafe#Pointer Signed-off-by: Eng Zer Jun <engzerjun@gmail.com>
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #1162 +/- ##
==========================================
+ Coverage 82.72% 83.92% +1.20%
==========================================
Files 162 166 +4
Lines 9080 7894 -1186
==========================================
- Hits 7511 6625 -886
+ Misses 1319 1019 -300
Partials 250 250
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
|
The change looks very reasonable to me. |
jcchavezs
approved these changes
Oct 2, 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.
Make sure that you've checked the boxes below before you submit PR:
Thanks for your contribution ❤️
Closes #1147.
The Godoc of
reflect.StringHeaderstates 1:And the Godoc of
unsafe.Pointerstates 2:The replacement
unsafe.StringDatais a more correct way to get the pointer to the string data. The original proposal can be seen in golang/go#53003 (comment).Footnotes
https://pkg.go.dev/reflect#StringHeader ↩
https://pkg.go.dev/unsafe#Pointer ↩