Skip to content

ReadBlockAsync docs unclear on difference to ReadAsync #1027

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

Open
ZoeyR opened this issue Oct 25, 2018 — with docs.microsoft.com · 1 comment
Open

ReadBlockAsync docs unclear on difference to ReadAsync #1027

ZoeyR opened this issue Oct 25, 2018 — with docs.microsoft.com · 1 comment
Labels
area-System.IO dotnet-api/prod Pri2 Indicates issues/PRs that are medium priority
Milestone

Comments

Copy link

ZoeyR commented Oct 25, 2018

The docs for ReadBlockAsync are almost identical to the docs for ReadAsync but their behavior is quite different. ReadBlockAsync appears to try and fill the buffer with count characters before returning, only returning early if the stream ended. ReadAsync on the other hand appears to fill a maximum of count characters, but will return early if there is no more data ready for reading.


Document Details

Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

@rpetrusha
Copy link

See the comment in #2930. The ReadAsync documentation should be aligned with Read, and the ReadBlockAsync documentation should be aligned with ReadBlock.

@rpetrusha rpetrusha removed the untriaged New issue has not been triaged by the area owner label Aug 6, 2019
@rpetrusha rpetrusha added this to the Backlog milestone Aug 6, 2019
@PRMerger9 PRMerger9 added the Pri2 Indicates issues/PRs that are medium priority label Jan 16, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area-System.IO dotnet-api/prod Pri2 Indicates issues/PRs that are medium priority
Projects
None yet
Development

No branches or pull requests

7 participants