Align MemoryStream Position and Seek docs with SetLength #11895
+2
−2
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
Updated ArgumentOutOfRangeException documentation for Position property and Seek method to include the more precise explanation about the maximum length calculation that accounts for the origin parameter. Both now match the detailed description in SetLength, specifying that the maximum length is (Int32.MaxValue - origin), where origin is the index into the underlying buffer at which the stream starts. Fixes dotnet#9201
github-actions
bot
added
the
needs-area-label
dotnet-policy-service
bot
added
the
community-contribution
dotnet-policy-service
bot
removed
the
needs-area-label
|
Tagging subscribers to this area: @dotnet/area-system-io |
|
Hello @gewarren , Have you had a chance to review my changes yet? |
Open
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.
Summary
ArgumentOutOfRangeExceptiondocumentation forMemoryStream.Positionproperty andMemoryStream.Seekmethod
SetLengthmethodoriginparameter affects the maximum valid position/offsetDetails
The
SetLengthmethod already included a precise explanation of theArgumentOutOfRangeExceptionthat mentionsthe
originparameter:However, the
Positionproperty andSeekmethod only mentionedInt32.MaxValuewithout explaining how theorigin affects the valid range.
Changes Made
Position property - Updated from:
To:
Seek method - Updated from:
To:
This provides developers with consistent and more accurate information about the actual constraints when working
with MemoryStream instances that may have been initialized with a non-zero origin offset.
Fixes #9201