DeflateStream.ReadAsync メソッド

定義

オーバーロード

ReadAsync(Memory<Byte>, CancellationToken)

現在の Deflate ストリームからバイト シーケンスを非同期に読み取り、バイト メモリの範囲に書き込んで、読み取られたバイト数だけ Deflate ストリーム内の位置を進め、キャンセル要求を監視します。Asynchronously reads a sequence of bytes from the current Deflate stream, writes them to a byte memory range, advances the position within the Deflate stream by the number of bytes read, and monitors cancellation requests.

ReadAsync(Byte[], Int32, Int32, CancellationToken)

現在の Deflate ストリームからバイト シーケンスを非同期に読み取り、バイト配列に書き込んで、読み取られたバイト数だけ Deflate ストリーム内の位置を進め、キャンセル要求を監視します。Asynchronously reads a sequence of bytes from the current Deflate stream, writes them to a byte array, advances the position within the Deflate stream by the number of bytes read, and monitors cancellation requests.

ReadAsync(Memory<Byte>, CancellationToken)

現在の Deflate ストリームからバイト シーケンスを非同期に読み取り、バイト メモリの範囲に書き込んで、読み取られたバイト数だけ Deflate ストリーム内の位置を進め、キャンセル要求を監視します。Asynchronously reads a sequence of bytes from the current Deflate stream, writes them to a byte memory range, advances the position within the Deflate stream by the number of bytes read, and monitors cancellation requests.

public override System.Threading.Tasks.ValueTask<int> ReadAsync (Memory<byte> buffer, System.Threading.CancellationToken cancellationToken = default);
override this.ReadAsync : Memory<byte> * System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask<int>
Public Overrides Function ReadAsync (buffer As Memory(Of Byte), Optional cancellationToken As CancellationToken = Nothing) As ValueTask(Of Integer)

パラメーター

buffer
Memory<Byte>

データを書き込むメモリの領域。The region of memory to write the data into.

cancellationToken
CancellationToken

キャンセル要求を監視するためのトークン。The token to monitor for cancellation requests. 既定値は None です。The default value is None.

戻り値

ValueTask<Int32>

非同期の読み取り操作を表すタスク。バッファーに読み取られたバイト数の合計がラップされます。A task that represents the asynchronous read operation, which wraps the total number of bytes read into the buffer. 要求しただけのバイト数を読み取ることができなかった場合、結果の値はバッファーに割り当てられているバイト数より小さくなります。Deflate ストリームの末尾に到達した場合は 0 (ゼロ) になることがあります。The result value can be less than the number of bytes allocated in the buffer if that many bytes are not currently available, or it can be 0 (zero) if the end of the Deflate stream has been reached.

注釈

ReadAsyncメソッドを使用すると、メインスレッドをブロックせずに、リソースを集中的に使用する i/o 操作を実行できます。The ReadAsync method enables you to perform resource-intensive I/O operations without blocking the main thread. このパフォーマンスに関する考慮事項は、時間のかかるストリーム操作によって UI スレッドがブロックされ、アプリが動作していないと見なされる可能性がある Windows 8.x ストアWindows 8.x Store アプリまたは デスクトップdesktop アプリで特に重要です。This performance consideration is particularly important in a Windows 8.x ストアWindows 8.x Store app or デスクトップdesktop app where a time-consuming stream operation can block the UI thread and make your app appear as if it is not working. 非同期メソッドは、 async Visual Basic および C# のキーワードとキーワードと組み合わせて使用され await ます。The async methods are used in conjunction with the async and await keywords in Visual Basic and C#.

CanRead現在のインスタンスが読み取りをサポートしているかどうかを確認するには、プロパティを使用します。Use the CanRead property to determine whether the current instance supports reading.

操作が完了前にキャンセルされた場合、返されたタスクには TaskStatus.Canceled プロパティの値が含まれ Task.Status ます。If the operation is canceled before it completes, the returned task contains the TaskStatus.Canceled value for the Task.Status property.

適用対象

ReadAsync(Byte[], Int32, Int32, CancellationToken)

現在の Deflate ストリームからバイト シーケンスを非同期に読み取り、バイト配列に書き込んで、読み取られたバイト数だけ Deflate ストリーム内の位置を進め、キャンセル要求を監視します。Asynchronously reads a sequence of bytes from the current Deflate stream, writes them to a byte array, advances the position within the Deflate stream by the number of bytes read, and monitors cancellation requests.

public:
 override System::Threading::Tasks::Task<int> ^ ReadAsync(cli::array <System::Byte> ^ array, int offset, int count, System::Threading::CancellationToken cancellationToken);
public override System.Threading.Tasks.Task<int> ReadAsync (byte[] array, int offset, int count, System.Threading.CancellationToken cancellationToken);
override this.ReadAsync : byte[] * int * int * System.Threading.CancellationToken -> System.Threading.Tasks.Task<int>
Public Overrides Function ReadAsync (array As Byte(), offset As Integer, count As Integer, cancellationToken As CancellationToken) As Task(Of Integer)

パラメーター

array
Byte[]

データを書き込むバッファー。The buffer to write the data into.

offset
Int32

Deflate ストリームからのデータの書き込み開始位置を示す array 内のバイト オフセット。The byte offset in array at which to begin writing data from the Deflate stream.

count
Int32

読み取る最大バイト数。The maximum number of bytes to read.

cancellationToken
CancellationToken

キャンセル要求を監視するためのトークン。The token to monitor for cancellation requests. 既定値は None です。The default value is None.

戻り値

Task<Int32>

非同期の読み取り操作を表すタスク。array に読み取られたバイト数の合計がラップされます。A task that represents the asynchronous read operation, which wraps the total number of bytes read into the array. 現在使用できるバイト数が要求した数より小さい場合、結果の値は要求したバイト数より小さくなることがあります。また、Deflate ストリームの末尾に到達した場合は 0 になることがあります。The result value can be less than the number of bytes requested if the number of bytes currently available is less than the requested number, or it can be 0 (zero) if the end of the Deflate stream has been reached.

注釈

ReadAsyncメソッドを使用すると、メインスレッドをブロックせずに、リソースを集中的に使用する i/o 操作を実行できます。The ReadAsync method enables you to perform resource-intensive I/O operations without blocking the main thread. このパフォーマンスに関する考慮事項は、時間のかかるストリーム操作によって UI スレッドがブロックされ、アプリが動作していないと見なされる可能性がある Windows 8.x ストアWindows 8.x Store アプリまたは デスクトップdesktop アプリで特に重要です。This performance consideration is particularly important in a Windows 8.x ストアWindows 8.x Store app or デスクトップdesktop app where a time-consuming stream operation can block the UI thread and make your app appear as if it is not working. 非同期メソッドは、 async Visual Basic および C# のキーワードとキーワードと組み合わせて使用され await ます。The async methods are used in conjunction with the async and await keywords in Visual Basic and C#.

CanRead現在のインスタンスが読み取りをサポートしているかどうかを確認するには、プロパティを使用します。Use the CanRead property to determine whether the current instance supports reading.

操作が完了前にキャンセルされた場合、返されたタスクには TaskStatus.Canceled プロパティの値が含まれ Task.Status ます。If the operation is canceled before it completes, the returned task contains the TaskStatus.Canceled value for the Task.Status property.

適用対象