DeflateStream.ReadAsync メソッド
定義
重要
一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。
オーバーロード
| 名前 | 説明 |
|---|---|
| ReadAsync(Memory<Byte>, CancellationToken) |
現在の Deflate ストリームからバイト シーケンスを非同期に読み取り、バイト メモリ範囲に書き込み、読み取ったバイト数だけ Deflate ストリーム内の位置を進め、キャンセル要求を監視します。 |
| ReadAsync(Byte[], Int32, Int32, CancellationToken) |
現在の Deflate ストリームからバイト シーケンスを非同期に読み取り、バイト配列に書き込み、読み取ったバイト数だけ Deflate ストリーム内の位置を進め、キャンセル要求を監視します。 |
ReadAsync(Memory<Byte>, CancellationToken)
- ソース:
- DeflateStream.cs
- ソース:
- DeflateStream.cs
- ソース:
- DeflateStream.cs
- ソース:
- DeflateStream.cs
- ソース:
- DeflateStream.cs
現在の Deflate ストリームからバイト シーケンスを非同期に読み取り、バイト メモリ範囲に書き込み、読み取ったバイト数だけ Deflate ストリーム内の位置を進め、キャンセル要求を監視します。
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)パラメーター
- cancellationToken
- CancellationToken
キャンセル要求を監視するトークン。 既定値は None です。
戻り値
非同期読み取り操作を表すタスク。バッファーに読み込まれる合計バイト数をラップします。 結果の値は、現在使用できないバイト数がバッファーに割り当てられたバイト数より小さい場合があります。Deflate ストリームの末尾に達した場合は 0 (ゼロ) にすることができます。
例外
キャンセル トークンが取り消されました。 この例外は、返されたタスクに格納されます。
注釈
Important
.NET 6 以降では、このメソッドは要求されたバイト数を読み取らない可能性があります。 詳細については、「 DeflateStream、GZipStream、CryptoStream の部分読み取りと 0 バイト読み取り」を参照してください。
ReadAsync メソッドを使用すると、メイン スレッドをブロックすることなく、リソースを大量に消費する I/O 操作を実行できます。 このパフォーマンスの考慮事項は、時間のかかるストリーム操作によって UI スレッドがブロックされ、アプリが動作していないかのように表示されるデスクトップ アプリで特に重要です。 非同期メソッドは、Visual Basic および C# の async キーワードと await キーワードと組み合わせて使用されます。
現在のインスタンスが読み取りをサポートしているかどうかを判断するには、 CanRead プロパティを使用します。
操作が完了する前に取り消された場合、返されるタスクには、Task.Status プロパティのTaskStatus.Canceled値が含まれます。
適用対象
ReadAsync(Byte[], Int32, Int32, CancellationToken)
- ソース:
- DeflateStream.cs
- ソース:
- DeflateStream.cs
- ソース:
- DeflateStream.cs
- ソース:
- DeflateStream.cs
- ソース:
- DeflateStream.cs
現在の Deflate ストリームからバイト シーケンスを非同期に読み取り、バイト配列に書き込み、読み取ったバイト数だけ Deflate ストリーム内の位置を進め、キャンセル要求を監視します。
public:
override System::Threading::Tasks::Task<int> ^ ReadAsync(cli::array <System::Byte> ^ buffer, int offset, int count, System::Threading::CancellationToken cancellationToken);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[] buffer, 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>override this.ReadAsync : byte[] * int * int * System.Threading.CancellationToken -> System.Threading.Tasks.Task<int>Public Overrides Function ReadAsync (buffer As Byte(), offset As Integer, count As Integer, cancellationToken As CancellationToken) As Task(Of Integer)Public Overrides Function ReadAsync (array As Byte(), offset As Integer, count As Integer, cancellationToken As CancellationToken) As Task(Of Integer)パラメーター
- arraybuffer
- Byte[]
データを書き込むバッファー。
- offset
- Int32
Deflate ストリームからのデータの書き込みを開始するバイト オフセット。
- count
- Int32
読み取る最大バイト数。
- cancellationToken
- CancellationToken
キャンセル要求を監視するトークン。 既定値は None です。
戻り値
非同期読み取り操作を表すタスク。バッファーに読み込まれる合計バイト数をラップします。 結果の値は、現在使用可能なバイト数が要求された数より少ない場合は要求されたバイト数より小さくすることができます。Deflate ストリームの末尾に達した場合は 0 (ゼロ) にすることができます。
例外
キャンセル トークンが取り消されました。 この例外は、返されたタスクに格納されます。
注釈
Important
.NET 6 以降では、このメソッドは要求されたバイト数を読み取らない可能性があります。 詳細については、「 DeflateStream、GZipStream、CryptoStream の部分読み取りと 0 バイト読み取り」を参照してください。
ReadAsync メソッドを使用すると、メイン スレッドをブロックすることなく、リソースを大量に消費する I/O 操作を実行できます。 このパフォーマンスの考慮事項は、時間のかかるストリーム操作によって UI スレッドがブロックされ、アプリが動作していないかのように表示されるデスクトップ アプリで特に重要です。 非同期メソッドは、Visual Basic および C# の async キーワードと await キーワードと組み合わせて使用されます。
現在のインスタンスが読み取りをサポートしているかどうかを判断するには、 CanRead プロパティを使用します。
操作が完了する前に取り消された場合、返されるタスクには、Task.Status プロパティのTaskStatus.Canceled値が含まれます。
このメソッドは、メソッドの同期的な例外がスローできるすべての非使用例外を返すタスクに格納します。 返されたタスクに例外が格納されている場合、その例外はタスクが待機しているときにスローされます。 ArgumentException などの使用に関する例外は、引き続き同期的にスローされます。 格納されている例外については、 Read(Byte[], Int32, Int32)によってスローされる例外を参照してください。
