TarReader.GetNextEntryAsync(Boolean, CancellationToken) メソッド

定義

名前空間:

System.Formats.Tar

アセンブリ:

System.Formats.Tar.dll

ソース:

TarReader.cs

アーカイブ ストリームから次のエントリを非同期的に取得します。

public System.Threading.Tasks.ValueTask<System.Formats.Tar.TarEntry?> GetNextEntryAsync (bool copyData = false, System.Threading.CancellationToken cancellationToken = default);

member this.GetNextEntryAsync : bool * System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask<System.Formats.Tar.TarEntry>

Public Function GetNextEntryAsync (Optional copyData As Boolean = false, Optional cancellationToken As CancellationToken = Nothing) As ValueTask(Of TarEntry)

パラメーター

copyData

Boolean

true エントリのデータを新しい MemoryStreamにコピーする場合は 。 これは、基になるアーカイブ ストリームがシークをサポートせず、後でデータにアクセスする必要がある場合に役立ちます。

false データを新しいストリームにコピーしない場合は 。 基になるストリームがシークをサポートしていない場合、ユーザーは、このメソッドを呼び出した直後に を読み取って処理する DataStream 必要があります。

既定値は false です。

cancellationToken

CancellationToken

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

戻り値

ValueTask<TarEntry>

有効なエントリが見つかった場合、またはnullアーカイブの末尾に達した場合は、インスタンスを含むTarEntry値タスク。

例外

InvalidDataException

アーカイブの形式が正しくありません。

または

アーカイブには、さまざまな形式のエントリが含まれています。

または

現在 Pax のアーカイブに複数のグローバル拡張属性エントリが見つかりました。

または

現在 Pax のアーカイブで 2 つ以上の拡張属性エントリが連続して見つかりました。

IOException

I/O の問題が発生しました。

OperationCanceledException

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

注釈

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