TarReader.GetNextEntryAsync(Boolean, CancellationToken) Método

Definición

Espacio de nombres:

System.Formats.Tar

Ensamblado:

System.Formats.Tar.dll

Source:

TarReader.cs

Recupera de forma asincrónica la siguiente entrada de la secuencia de archivo.

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)

Parámetros

copyData

Boolean

true para copiar los datos de la entrada en un nuevo MemoryStream. Esto resulta útil cuando la secuencia de archivo subyacente no admite la búsqueda y se debe tener acceso a los datos más adelante.

false si los datos no se deben copiar en una nueva secuencia. Si la secuencia subyacente no admite la búsqueda, el usuario tiene la responsabilidad de leer y procesar inmediatamente DataStream después de llamar a este método.

El valor predeterminado es false.

cancellationToken

CancellationToken

Token para supervisar solicitudes de cancelación. El valor predeterminado es None.

Devoluciones

ValueTask<TarEntry>

Tarea de valor que contiene una TarEntry instancia de si se encontró una entrada válida o null si se ha alcanzado el final del archivo.

Excepciones

InvalidDataException

El archivo tiene un formato incorrecto.

O bien

El archivo contiene entradas en diferentes formatos.

O bien

Se encontró más de una entrada de atributos extendidos globales en el archivo actual Pax .

O bien

Dos o más entradas de atributos extendidos se encontraron consecutivamente en el archivo actual Pax .

IOException

Se ha producido un problema de E/S.

OperationCanceledException

Se canceló el token de cancelación. Esta excepción se almacena en la tarea devuelta.

Comentarios

Este método almacena en la tarea que devuelve todas las excepciones que no son de uso que puede producir el homólogo sincrónico del método. Si se almacena una excepción en la tarea devuelta, esa excepción se producirá cuando se espere a la tarea. Las excepciones de uso, como ArgumentException, se siguen produciendo de forma sincrónica. Para ver las excepciones almacenadas, vea las excepciones producidas por GetNextEntry(Boolean).