GZipStream.ReadAsync Método
Definição
Importante
Algumas informações dizem respeito a um produto pré-lançado que pode ser substancialmente modificado antes de ser lançado. A Microsoft não faz garantias, de forma expressa ou implícita, em relação à informação aqui apresentada.
Sobrecargas
| Name | Description |
|---|---|
| ReadAsync(Memory<Byte>, CancellationToken) |
A leitura assíncrona uma sequência de bytes do fluxo GZip atual para uma região de memória de bytes, avança a posição dentro do fluxo GZip pelo número de bytes lidos e monitoriza pedidos de cancelamento. |
| ReadAsync(Byte[], Int32, Int32, CancellationToken) |
A leitura assíncrona uma sequência de bytes do fluxo GZip atual para um array de bytes, avança a posição dentro do fluxo GZip pelo número de bytes lidos e monitoriza pedidos de cancelamento. |
ReadAsync(Memory<Byte>, CancellationToken)
A leitura assíncrona uma sequência de bytes do fluxo GZip atual para uma região de memória de bytes, avança a posição dentro do fluxo GZip pelo número de bytes lidos e monitoriza pedidos de cancelamento.
public override System.Threading.Tasks.ValueTask<int> ReadAsync(Memory<byte> buffer, System.Threading.CancellationToken cancellationToken = default);override this.ReadAsync : Memory<byte> * System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask<int>Public Overrides Function ReadAsync (buffer As Memory(Of Byte), Optional cancellationToken As CancellationToken = Nothing) As ValueTask(Of Integer)Parâmetros
- cancellationToken
- CancellationToken
O token para monitorizar pedidos de cancelamento. O valor predefinido é None.
Devoluções
Uma tarefa que representa a operação de leitura assíncrona, que envolve o número total de bytes lidos no buffer. O valor do resultado pode ser inferior ao número de bytes alocados no buffer se esse número de bytes não estiver disponível atualmente, ou pode ser 0 (zero) se o fim do fluxo GZip for atingido.
Exceções
O token de cancelamento foi cancelado. Esta exceção é armazenada na tarefa devolvida.
Observações
Importante
A partir do .NET 6, este método pode não ler tantos bytes quanto os solicitados. Para mais informações, consulte Leituras parciais e de zero bytes no DeflateStream, GZipStream e CryptoStream.
O ReadAsync método permite-lhe realizar operações de I/O que consomem muitos recursos sem bloquear o thread principal. Esta consideração de desempenho é particularmente importante em aplicações de ambiente de trabalho, onde uma operação de stream demorada pode bloquear o thread da interface e fazer a aplicação parecer que não está a funcionar. Os métodos assíncronos são usados em conjunto com as palavras-chave async e await em Visual Basic e C#.
Use a CanRead propriedade para determinar se a instância atual suporta leitura.
Se a operação for cancelada antes de ser concluída, a tarefa devolvida contém o TaskStatus.Canceled valor da Task.Status propriedade.
Aplica-se a
ReadAsync(Byte[], Int32, Int32, CancellationToken)
A leitura assíncrona uma sequência de bytes do fluxo GZip atual para um array de bytes, avança a posição dentro do fluxo GZip pelo número de bytes lidos e monitoriza pedidos de cancelamento.
public:
override System::Threading::Tasks::Task<int> ^ ReadAsync(cli::array <System::Byte> ^ array, int offset, int count, System::Threading::CancellationToken cancellationToken);public override System.Threading.Tasks.Task<int> ReadAsync(byte[] array, int offset, int count, System.Threading.CancellationToken cancellationToken);abstract member ReadAsync : byte[] * int * int * System.Threading.CancellationToken -> System.Threading.Tasks.Task<int>
override this.ReadAsync : byte[] * int * int * System.Threading.CancellationToken -> System.Threading.Tasks.Task<int>override this.ReadAsync : byte[] * int * int * System.Threading.CancellationToken -> System.Threading.Tasks.Task<int>Public Overrides Function ReadAsync (array As Byte(), offset As Integer, count As Integer, cancellationToken As CancellationToken) As Task(Of Integer)Parâmetros
- arraybuffer
- Byte[]
O buffer para escrever os dados.
- offset
- Int32
O deslocamento de bytes a partir do qual começar a escrever dados do fluxo GZip.
- count
- Int32
O número máximo de bytes a ler.
- cancellationToken
- CancellationToken
O token para monitorizar pedidos de cancelamento. O valor predefinido é None.
Devoluções
Uma tarefa que representa a operação de leitura assíncrona, que envolve o número total de bytes lidos. O valor do resultado pode ser inferior ao número de bytes solicitados se o número de bytes atualmente disponíveis for inferior ao número pedido, ou pode ser 0 (zero) se o fim do fluxo GZip for atingido.
Exceções
O token de cancelamento foi cancelado. Esta exceção é armazenada na tarefa devolvida.
Observações
Importante
A partir do .NET 6, este método pode não ler tantos bytes quanto os solicitados. Para mais informações, consulte Leituras parciais e de zero bytes no DeflateStream, GZipStream e CryptoStream.
O ReadAsync método permite-lhe realizar operações de I/O que consomem muitos recursos sem bloquear o thread principal. Esta consideração de desempenho é particularmente importante em aplicações de ambiente de trabalho, onde uma operação de stream demorada pode bloquear o thread da interface e fazer a aplicação parecer que não está a funcionar. Os métodos assíncronos são usados em conjunto com as palavras-chave async e await em Visual Basic e C#.
Use a CanRead propriedade para determinar se a instância atual suporta leitura.
Se a operação for cancelada antes de ser concluída, a tarefa devolvida contém o TaskStatus.Canceled valor da Task.Status propriedade.
Este método armazena na tarefa que devolve todas as exceções de não-utilização que o equivalente síncrono do método pode lançar. Se uma exceção for armazenada na tarefa devolvida, essa exceção será lançada quando a tarefa for aguardada. As exceções de uso, como ArgumentException, ainda são lançadas de forma síncrona. Para as exceções armazenadas, veja as exceções lançadas por Read(Byte[], Int32, Int32).