Stream.ReadAtLeastAsync Metode

Definisi

Ruang nama:

System.IO

Rakitan:

System.Runtime.dll

Sumber:

Stream.cs

Secara asinkron membaca setidaknya jumlah minimum byte dari aliran saat ini, memajukan posisi dalam aliran dengan jumlah byte yang dibaca, dan memantau permintaan pembatalan.

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)

Parameter

buffer

Memory<Byte>

Wilayah memori untuk menulis data.

minimumBytes

Int32

Jumlah minimum byte yang akan dibaca ke dalam buffer.

throwOnEndOfStream

Boolean

true untuk melemparkan pengecualian jika akhir aliran tercapai sebelum pembacaan minimumBytes byte; false untuk mengembalikan kurang dari minimumBytes saat akhir aliran tercapai. Default adalah true.

cancellationToken

CancellationToken

Token yang akan dipantau untuk permintaan pembatalan.

Mengembalikan

ValueTask<Int32>

Tugas yang mewakili operasi baca asinkron. Nilai propertinya Result berisi jumlah total byte yang dibaca ke dalam buffer. Ini dijamin lebih besar dari atau sama dengan minimumBytes ketika throwOnEndOfStream adalah true. Ini akan kurang dari minimumBytes ketika akhir aliran tercapai dan throwOnEndOfStream adalah false. Ini bisa kurang dari jumlah byte yang dialokasikan di buffer jika banyak byte saat ini tidak tersedia.

Pengecualian

ArgumentOutOfRangeException

minimumBytes negatif, atau lebih besar dari panjang buffer.

EndOfStreamException

throwOnEndOfStream adalah true dan akhir aliran dicapai sebelum membaca minimumBytes byte data.

OperationCanceledException

Token pembatalan dibatalkan. Pengecualian ini disimpan ke dalam tugas yang dikembalikan.

Keterangan

Ketika minimumBytes adalah 0 (nol), operasi baca ini akan selesai tanpa menunggu data yang tersedia di aliran.