Utf8JsonWriter.FlushAsync(CancellationToken) Method

Definition

Namespace:

System.Text.Json

Assembly:

System.Text.Json.dll

Package:

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

Source:

Utf8JsonWriter.cs

Asynchronously commits the JSON text written so far, which makes it visible to the output destination.

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

Parameters

cancellationToken

CancellationToken

The token to monitor for cancellation requests. The default value is None.

Returns

Task

A task representing the asynchronous flush operation.

Exceptions

ObjectDisposedException

This instance has been disposed.

OperationCanceledException

The cancellation token was canceled. This exception is stored into the returned task.

Remarks

In the case of IBufferWriter, this advances the underlying IBufferWriter<T> based on what has been written so far.

In the case of Stream, this writes the data to the stream and flushes it asynchronously, while monitoring cancellation requests.

This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as ArgumentException, are still thrown synchronously. For the stored exceptions, see the exceptions thrown by Flush().