Utf8JsonWriter.FlushAsync(CancellationToken) メソッド

定義

名前空間:

System.Text.Json

アセンブリ:

System.Text.Json.dll

パッケージ:

System.Text.Json v9.0.0-preview.3.24172.9

ソース:

Utf8JsonWriter.cs

これまでに書き込まれた JSON テキストを非同期的にコミットします。これにより出力先で表示できるようになります。

public System.Threading.Tasks.Task FlushAsync (System.Threading.CancellationToken cancellationToken = default);

member this.FlushAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task

Public Function FlushAsync (Optional cancellationToken As CancellationToken = Nothing) As Task

パラメーター

cancellationToken

CancellationToken

キャンセル要求を監視するためのトークン。 既定値は None です。

戻り値

Task

非同期のフラッシュ操作を表すタスク。

例外

ObjectDisposedException

このインスタンスは破棄されています。

OperationCanceledException

キャンセル トークンが取り消されました。 この例外は、返されたタスクに格納されます。

注釈

IBufferWriter の場合、これにより、これまでに記述された内容に基づいて基になる IBufferWriter<T> が進みます。

の Stream場合、これはデータをストリームに書き込み、取り消し要求を監視しながら非同期的にフラッシュします。

このメソッドは、メソッドの同期例外がスローできる非使用例外をすべて返すタスクに格納します。 返されたタスクに例外が格納されている場合、その例外はタスクが待機されたときにスローされます。 などの ArgumentException使用例外は、引き続き同期的にスローされます。 格納されている例外については、 によって Flush()スローされる例外に関するページを参照してください。