- Notifications
You must be signed in to change notification settings - Fork1.6k
Fix FileStream.FlushAsync documentation to correctly describe its behavior#11471
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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Merged
Uh oh!
There was an error while loading.Please reload this page.
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
…o underlying deviceCo-authored-by: jeffhandley <1031940+jeffhandley@users.noreply.github.com>
Copilot finished work on behalf ofjeffhandleyJune 19, 2025 05:38
jeffhandley approved these changesJun 19, 2025
gewarren approved these changesJun 30, 2025
Uh oh!
There was an error while loading.Please reload this page.
Co-authored-by: gewarren <24882762+gewarren@users.noreply.github.com>
auto-merge was automatically disabledJune 30, 2025 13:41
Head branch was pushed to by a user without write access
Copilot finished work on behalf ofgewarrenJune 30, 2025 13:42
gewarren approved these changesJun 30, 2025
c5eea03 intomain 5 checks passed
Uh oh!
There was an error while loading.Please reload this page.
Sign up for freeto join this conversation on GitHub. Already have an account?Sign in to comment
Labels
None yet
3 participants
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.
Uh oh!
There was an error while loading.Please reload this page.
The documentation for
FileStream.FlushAsync(CancellationToken)incorrectly stated that it "causes any buffered data to be written to the underlying device". This is inaccurate based on the behavior change implemented indotnet/coreclr#24902.Issue
The current documentation was misleading because:
FlushAsync()behaves likeFlush()/Flush(false)- it only flushes .NET stream buffers to the fileFlush(true)actually performs the expensive operation of flushing OS buffers to diskChanges
Flush(true)when flushing to the underlying storage device is requiredThis ensures developers have accurate expectations about the performance and behavior of
FlushAsync()versusFlush(true).Fixes#11433.
💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Clickhere to start the survey.