TarReader.GetNextEntryAsync(Boolean, CancellationToken) Méthode

Définition

Espace de noms:

System.Formats.Tar

Assembly:

System.Formats.Tar.dll

Source:

TarReader.cs

Récupère de façon asynchrone l’entrée suivante à partir du flux d’archive.

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)

Paramètres

copyData

Boolean

true pour copier les données de l’entrée dans un nouveau MemoryStream. Cela est utile lorsque le flux d’archive sous-jacent ne prend pas en charge la recherche et que les données doivent être consultées ultérieurement.

false si les données ne doivent pas être copiées dans un nouveau flux. Si le flux sous-jacent ne prend pas en charge la recherche, l’utilisateur a la responsabilité de lire et de traiter immédiatement DataStream après l’appel de cette méthode.

La valeur par défaut est false.

cancellationToken

CancellationToken

Jeton pour surveiller les requêtes d'annulation. La valeur par défaut est None.

Retours

ValueTask<TarEntry>

Tâche de valeur contenant un TarEntry instance si une entrée valide a été trouvée ou null si la fin de l’archive a été atteinte.

Exceptions

InvalidDataException

L’archive est incorrecte.

-ou-

L’archive contient des entrées dans différents formats.

-ou-

Plusieurs entrées d’attributs étendus globaux ont été trouvées dans l’archive actuelle Pax .

-ou-

Au moins deux entrées d’attributs étendus ont été trouvées consécutivement dans l’archive actuelle Pax .

IOException

Un problème d’E/S s’est produit.

OperationCanceledException

Le jeton d’annulation a été annulé. Cette exception est stockée dans la tâche retournée.

Remarques

Cette méthode stocke dans la tâche toutes les exceptions de non-utilisation que l’équivalent synchrone de la méthode peut lever. Si une exception est stockée dans la tâche retournée, cette exception sera levée lorsque la tâche est attendue. Les exceptions d’utilisation, telles que ArgumentException, sont toujours levées de manière synchrone. Pour connaître les exceptions stockées, consultez les exceptions levées par GetNextEntry(Boolean).