Document caution regarding AdvanceTo's side effect #3659
Merged
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
After calling `PipeReader.AdvanceTo`, the `ReadResult.Buffer` property's backing data is recycled, leading to indeterministic changes to not only the content but its `Length` property. This isn't particular predictable as a consumer and the docs didn't make it clear either.
carlossanlop
requested review from
halter73,
davidfowl,
jkotalik and
analogrelay
and removed request for
jozkee
jkotalik
approved these changes
Dec 11, 2019
davidfowl
approved these changes
Dec 11, 2019
halter73
approved these changes
Dec 11, 2019
BillWagner
requested changes
Dec 12, 2019
There was a problem hiding this comment.
Thanks for adding this @AArnott
I have one suggestion to replace the code fences with xref links. Then, it's ready to merge.
Co-Authored-By: Bill Wagner <[email protected]>
BillWagner
approved these changes
Dec 12, 2019
|
Thanks for the update @AArnott I'll |
now.
|
Thanks. |
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.
After calling
PipeReader.AdvanceTo, theReadResult.Bufferproperty's backing data is recycled, leading to indeterministic changes to not only the content but itsLengthproperty. This isn't particular predictable as a consumer and the docs didn't make it clear either.This updates the docs to match the updated xml doc comments from dotnet/runtime#691