TarReader.GetNextEntryAsync(Boolean, CancellationToken) Metoda

Definice

Obor názvů:

System.Formats.Tar

Sestavení:

System.Formats.Tar.dll

Zdroj:

TarReader.cs

Asynchronně načte další položku z archivního datového proudu.

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)

Parametry

copyData

Boolean

true a zkopírujte data záznamu do nového MemoryStreamobjektu . To je užitečné, pokud podkladový archivní datový proud nepodporuje vyhledávání a k datům je potřeba získat přístup později.

false pokud se data nemají kopírovat do nového datového proudu. Pokud podkladový datový proud nepodporuje vyhledávání, má uživatel odpovědnost za čtení a zpracování DataStream okamžitě po volání této metody.

Výchozí hodnota je false.

cancellationToken

CancellationToken

Token, který se má monitorovat pro žádosti o zrušení. Výchozí hodnota je None.

Návraty

ValueTask<TarEntry>

Úkol hodnoty obsahující TarEntry instanci, pokud byla nalezena platná položka nebo null pokud bylo dosaženo konce archivu.

Výjimky

InvalidDataException

Archiv je poškozený.

-nebo-

Archiv obsahuje položky v různých formátech.

-nebo-

V aktuálním Pax archivu byla nalezena více než jedna položka globálních rozšířených atributů.

-nebo-

V aktuálním Pax archivu byly po sobě nalezeny dvě nebo více položek rozšířených atributů.

IOException

Došlo k problému se vstupně-výstupními operacemi.

OperationCanceledException

Token zrušení byl zrušen. Tato výjimka je uložena ve vrácené úloze.

Poznámky

Tato metoda ukládá do úlohy, která vrací všechny výjimky nesouvisejí s používáním, které může vyvolat synchronní protějšek metody. Pokud je ve vrácené úloze uložena výjimka, bude tato výjimka vyvolána při čekání na úkol. Výjimky použití, například ArgumentException, jsou stále vyvolány synchronně. Informace o uložených výjimkách najdete v tématu Výjimky vyvolané nástrojem GetNextEntry(Boolean).