dotnet / dotnet/dotnet-api-docs

ReadBlockAsync docs unclear on difference to ReadAsync

Offen
#1,027 1 Kommentar 7 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen
area-System.IO dotnet-api/prod Pri2
Vorherrschende Sprache
C#
Sterne
950
Forks
1.7k
Ø Merge
2 T. 19 Std.
Gemergte PRs (30 T.)
52

Beschreibung

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.*

* ID: 3988e630-dd5b-611e-7767-4c5aec0622ae
* Version Independent ID: 9169e86f-d936-61f7-243e-a3d2816fb170
* Content: [StreamReader.ReadBlockAsync Method (System.IO)](https://docs.microsoft.com/en-us/dotnet/api/system.io.streamreader.readblockasync?view=netframework-4.7.2)
* Content Source: [xml/System.IO/StreamReader.xml](https://github.com/dotnet/dotnet-api-docs/blob/master/xml/System.IO/StreamReader.xml)
* Product: **dotnet-api**
* GitHub Login: @dotnet-bot
* Microsoft Alias: **dotnetcontent**

Beitragsleitfaden

Beitragsleitfaden öffnen

Rechercherichtung

Beginne in xml/System.IO/StreamReader.xml und vergleiche die Dokumentationseinträge für ReadBlockAsync und ReadAsync. Stelle klar, dass ReadBlockAsync versucht, die angeforderte Anzahl zu füllen, sofern der Stream nicht endet, während ReadAsync zurückkehren kann, wenn unmittelbar keine weiteren Daten verfügbar sind. Die Aufgabe ist erledigt, wenn der dokumentierte Unterschied klar ist und die beiden Einträge nicht mehr nahezu identisch erscheinen.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
csharp
Bereich
documentation
Issue-Typ
Dokumentation
Schwierigkeit
1/5
Geschätzter Aufwand
1-3 Stunden
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
48/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.