TarReader.GetNextEntryAsync(Boolean, CancellationToken) Método

Definição

Namespace:

System.Formats.Tar

Assembly:

System.Formats.Tar.dll

Origem:

TarReader.cs

Recupera de forma assíncrona a próxima entrada do fluxo de arquivos.

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 os dados da entrada em um novo MemoryStream. Isso é útil quando o fluxo de arquivos subjacente não dá suporte à busca e os dados precisam ser acessados posteriormente.

false se os dados não devem ser copiados em um novo fluxo. Se o fluxo subjacente não oferecer suporte à busca, o usuário terá a responsabilidade de ler e processar o DataStream imediatamente após chamar esse método.

O valor padrão é false.

cancellationToken

CancellationToken

O token a se monitorar para solicitações de cancelamento. O valor padrão é None.

Retornos

ValueTask<TarEntry>

Uma tarefa de valor que contém uma TarEntry instância se uma entrada válida foi encontrada ou null se o final do arquivo foi atingido.

Exceções

InvalidDataException

O arquivo está malformado.

-ou-

O arquivo contém entradas em formatos diferentes.

-ou-

Mais de uma Entrada global de atributos estendidos foi encontrada no arquivo atual Pax .

-ou-

Duas ou mais entradas de Atributos Estendidos foram encontradas consecutivamente no arquivo morto atual Pax .

IOException

Ocorreu um problema de E/S.

OperationCanceledException

O token de cancelamento foi cancelado. Essa exceção é armazenada na tarefa retornada.

Comentários

Esse método armazena na tarefa que retorna todas as exceções de não uso que o equivalente síncrono do método pode gerar. Se uma exceção for armazenada na tarefa retornada, essa exceção será gerada quando a tarefa for aguardada. Exceções de uso, como ArgumentException, ainda são geradas de forma síncrona. Para as exceções armazenadas, consulte as exceções geradas por GetNextEntry(Boolean).