TarReader.DisposeAsync Method

Definition

Namespace:

System.Formats.Tar

Assembly:

System.Formats.Tar.dll

Source:

TarReader.cs

Asynchronously disposes the current TarReader instance, and closes the streams of all the entries that were read from the archive if the leaveOpen argument was set to false in the constructor.

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 value task that represents the asynchronous dispose operation.

Implements

DisposeAsync()

Remarks

The DataStream property of any entry can be replaced with a new stream. If the user decides to replace it on a TarEntry instance that was obtained using a TarReader, the underlying stream gets disposed immediately, freeing the TarReader of origin from the responsibility of having to dispose it.

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