TarReader.GetNextEntryAsync(Boolean, CancellationToken) Metodo

Definizione

Spazio dei nomi:

System.Formats.Tar

Assembly:

System.Formats.Tar.dll

Origine:

TarReader.cs

Recupera in modo asincrono la voce successiva dal flusso di archiviazione.

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)

Parametri

copyData

Boolean

true per copiare i dati della voce in un nuovo MemoryStreamoggetto . Questo è utile quando il flusso di archiviazione sottostante non supporta la ricerca e i dati devono essere accessibili in un secondo momento.

false se i dati non devono essere copiati in un nuovo flusso. Se il flusso sottostante non supporta la ricerca, l'utente ha la responsabilità di leggere ed elaborare immediatamente DataStream dopo aver chiamato questo metodo.

Il valore predefinito è false.

cancellationToken

CancellationToken

Token da monitorare per le richieste di annullamento. Il valore predefinito è None.

Restituisce

ValueTask<TarEntry>

Attività valore contenente un'istanza se è stata trovata una TarEntry voce valida o null se è stata raggiunta la fine dell'archivio.

Eccezioni

InvalidDataException

L'archivio è non valido.

-oppure-

L'archivio contiene voci in formati diversi.

-oppure-

Nell'archivio corrente Pax sono stati trovati più attributi estesi globali.

-oppure-

Due o più voci di attributi estesi sono state trovate consecutivamente nell'archivio corrente Pax .

IOException

Si è verificato un problema di I/O.

OperationCanceledException

Il token di annullamento è stato annullato. Questa eccezione viene archiviata nell'attività restituita.

Commenti

Questo metodo archivia nell'attività che restituisce tutte le eccezioni non di utilizzo che la controparte sincrona del metodo può generare. Se un'eccezione viene archiviata nell'attività restituita, tale eccezione verrà generata quando l'attività è attesa. Le eccezioni di utilizzo, ad esempio ArgumentException, vengono comunque generate in modo sincrono. Per le eccezioni archiviate, vedere le eccezioni generate da GetNextEntry(Boolean).