-
Notifications
You must be signed in to change notification settings - Fork 1.6k
Mention the breaking change on reading CryptoStream in .NET 6. #7379
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Mention the breaking change on reading CryptoStream in .NET 6. #7379
Conversation
Tagging subscribers to this area: @bartonjs, @vcsjones, @krwq, @GrabYourPitchforks Issue DetailsSummaryAs mentioned in dotnet/core#6895, a breaking change was implemented on reading CryptoStream on .NET 6. This edit adds some pointers to that in the CryptoStream documentation.
|
Docs Build status updates of commit db6c6b8: ✅ Validation status: passed
For more details, please refer to the build report. Note: Broken links written as relative paths are included in the above build report. For broken links written as absolute paths or external URLs, see the broken link report. For any questions, please:
|
I suggested this note here as so far we've had two or three reports of it breaking folks. |
The technical content LGTM, withholding a checkmark to make sure that voice and style get the OK. It feels a little redundant to me, since that's what the general contract for streams is (though the zero length buffer thing is an inconsistent edge case)... but I agree that it has come up enough that people were clearly depending on CryptoStream behaving this way and might not realize that it was in the minority for having done so. |
I wonder whether we might want to word this instead as just documentation behavior eg
or something like that. Basically, favor the future rather than the past! |
How's this? We should add to DeflateStream and GZipStream as well |
Docs Build status updates of commit a67645f: ✅ Validation status: passed
For more details, please refer to the build report. Note: Broken links written as relative paths are included in the above build report. For broken links written as absolute paths or external URLs, see the broken link report. For any questions, please:
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I left some formatting suggestions.
Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com>
Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com>
Thanks. Good to merge? |
Docs Build status updates of commit 22fb7b5: ✅ Validation status: passed
For more details, please refer to the build report. Note: Broken links written as relative paths are included in the above build report. For broken links written as absolute paths or external URLs, see the broken link report. For any questions, please:
|
Docs Build status updates of commit 0411e2d: ✅ Validation status: passed
For more details, please refer to the build report. Note: Broken links written as relative paths are included in the above build report. For broken links written as absolute paths or external URLs, see the broken link report. For any questions, please:
|
Docs Build status updates of commit f6adf51: ✅ Validation status: passed
For more details, please refer to the build report. Note: Broken links written as relative paths are included in the above build report. For broken links written as absolute paths or external URLs, see the broken link report. For any questions, please:
|
Docs Build status updates of commit f6adf51: ✅ Validation status: passed
For more details, please refer to the build report. Note: Broken links written as relative paths are included in the above build report. For broken links written as absolute paths or external URLs, see the broken link report. For any questions, please:
|
Summary
As mentioned in dotnet/core#6895, a breaking change was implemented on reading CryptoStream on .NET 6. This edit adds some pointers to that in the CryptoStream documentation.