Stream.ReadAtLeastAsync メソッド

リファレンス

定義

名前空間:: System.IO

アセンブリ:: System.Runtime.dll

ソース:: Stream.cs

ソース:: Stream.cs

ソース:: Stream.cs

重要

一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。

現在のストリームから少なくとも最小バイト数を非同期に読み取り、読み取られたバイト数だけストリーム内の位置を進め、キャンセル要求を監視します。

public System.Threading.Tasks.ValueTask<int> ReadAtLeastAsync (Memory<byte> buffer, int minimumBytes, bool throwOnEndOfStream = true, System.Threading.CancellationToken cancellationToken = default);

member this.ReadAtLeastAsync : Memory<byte> * int * bool * System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask<int>

Public Function ReadAtLeastAsync (buffer As Memory(Of Byte), minimumBytes As Integer, Optional throwOnEndOfStream As Boolean = true, Optional cancellationToken As CancellationToken = Nothing) As ValueTask(Of Integer)

パラメーター

buffer: Memory<Byte>

データを書き込むメモリの領域。

minimumBytes: Int32

バッファーに読み込む最小バイト数。

throwOnEndOfStream: Boolean

trueストリームの末尾がバイトfalseの読み取minimumBytesり前に到達した場合に例外をスローする場合は。ストリームの末尾に達した場合よりもminimumBytes小さい値を返す場合は。既定では、 trueです。

cancellationToken: CancellationToken

キャンセル要求を監視するためのトークン。

戻り値

ValueTask<Int32>

非同期の読み取り操作を表すタスク。その Result プロパティの値には、バッファーに読み取られるバイトの合計数が含まれます。がの場合throwOnEndOfStream、これは以上であることがminimumBytes保証されますtrue。これは、ストリームの末尾に達しthrowOnEndOfStreamfalse、がの場合よりもminimumBytes小さくなります。この値は、バッファーに割り当てられているバイト数よりも小さい場合があります (そのバイト数が現在使用できない場合)。