Utf8JsonWriter.DisposeAsync Method

Definition

Namespace:

System.Text.Json

Assembly:

System.Text.Json.dll

Package:

System.Text.Json v9.0.0-rc.2.24473.5

Source:

Utf8JsonWriter.cs

Asynchronously commits any leftover JSON text that has not yet been flushed and releases all resources used by the current instance.

public:
 virtual System::Threading::Tasks::ValueTask DisposeAsync();

public System.Threading.Tasks.ValueTask DisposeAsync ();

abstract member DisposeAsync : unit -> System.Threading.Tasks.ValueTask
override this.DisposeAsync : unit -> System.Threading.Tasks.ValueTask

Public Function DisposeAsync () As ValueTask

Returns

ValueTask

A task representing the asynchronous dispose operation.

Implements

DisposeAsync()

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.

The Utf8JsonWriter instance cannot be reused after disposing.

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 Dispose().