Stream.ReadAsync Método

Definição

Namespace:

System.IO

Assembly:

System.Runtime.dll

Lê uma sequência de bytes do fluxo atual de forma assíncrona e avança a posição no fluxo até o número de bytes lidos.

Sobrecargas

ReadAsync(Memory<Byte>, CancellationToken)	Lê de forma assíncrona uma sequência de bytes do fluxo atual, avança a posição no fluxo até o número de bytes lidos e monitora as solicitações de cancelamento.
ReadAsync(Byte[], Int32, Int32)	Lê uma sequência de bytes do fluxo atual de forma assíncrona e avança a posição no fluxo até o número de bytes lidos.
ReadAsync(Byte[], Int32, Int32, CancellationToken)	Lê de forma assíncrona uma sequência de bytes do fluxo atual, avança a posição no fluxo até o número de bytes lidos e monitora as solicitações de cancelamento.

ReadAsync(Memory<Byte>, CancellationToken)

Origem:

Stream.cs

Lê de forma assíncrona uma sequência de bytes do fluxo atual, avança a posição no fluxo até o número de bytes lidos e monitora as solicitações de cancelamento.

public virtual System.Threading.Tasks.ValueTask<int> ReadAsync (Memory<byte> buffer, System.Threading.CancellationToken cancellationToken = default);

abstract member ReadAsync : Memory<byte> * System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask<int>
override this.ReadAsync : Memory<byte> * System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask<int>

Public Overridable Function ReadAsync (buffer As Memory(Of Byte), Optional cancellationToken As CancellationToken = Nothing) As ValueTask(Of Integer)

Parâmetros

buffer

Memory<Byte>

A região da memória na qual gravar os dados.

cancellationToken

CancellationToken

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

Retornos

ValueTask<Int32>

Uma tarefa que representa a operação de leitura assíncrona. O valor de sua propriedade Result contém o número total de bytes lidos no buffer. O valor do resultado pode ser menor do que o comprimento do buffer se muitos bytes não estiverem disponíveis no momento ou pode ser 0 (zero) se o comprimento do buffer for 0 ou se o final do fluxo tiver sido atingido.

Exceções

OperationCanceledException

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

Comentários

O ReadAsync método permite que você execute operações de E/S com uso intensivo de recursos sem bloquear o thread main. Essa consideração sobre o desempenho é particularmente importante em um aplicativo da Microsoft Store 8.x ou aplicativo de desktop em que uma operação demorada de fluxo pode bloquear o thread de interface do usuário e fazer seu aplicativo parecer como se não estivesse funcionando. Os métodos assíncronos são usados em conjunto com as async palavras-chave e await no Visual Basic e no C#.

Use a CanRead propriedade para determinar se a instância atual dá suporte à leitura.

Se a operação for cancelada antes de ser concluída, a tarefa retornada conterá o TaskStatus.Canceled valor da Status propriedade .

Para obter um exemplo, consulte a ReadAsync(Byte[], Int32, Int32) sobrecarga.

ReadAsync(Byte[], Int32, Int32)

Origem:

Stream.cs

Lê uma sequência de bytes do fluxo atual de forma assíncrona e avança a posição no fluxo até o número de bytes lidos.

public:
 System::Threading::Tasks::Task<int> ^ ReadAsync(cli::array <System::Byte> ^ buffer, int offset, int count);

public System.Threading.Tasks.Task<int> ReadAsync (byte[] buffer, int offset, int count);

member this.ReadAsync : byte[] * int * int -> System.Threading.Tasks.Task<int>

Public Function ReadAsync (buffer As Byte(), offset As Integer, count As Integer) As Task(Of Integer)

Parâmetros

buffer

Byte[]

O buffer no qual os dados serão gravados.

offset

Int32

O deslocamento de bytes no buffer no qual será iniciada a gravação de dados no fluxo.

count

Int32

O número máximo de bytes a serem lidos.

Retornos

Task<Int32>

Uma tarefa que representa a operação de leitura assíncrona. O valor do parâmetro TResult contém o número total de bytes lidos no buffer. O valor do resultado pode ser menor do que o número de bytes solicitados se o número de bytes atualmente disponível for menor que o número solicitado ou pode ser 0 (zero) se count for 0 ou se o final do fluxo tiver sido atingido.

Exceções

ArgumentNullException

buffer é null.

ArgumentOutOfRangeException

offset ou count é negativo.

ArgumentException

A soma de offset e count é maior que o tamanho do buffer.

NotSupportedException

Não há suporte para leitura no fluxo.

ObjectDisposedException

O fluxo foi descartado.

InvalidOperationException

O fluxo está sendo usado no momento por uma operação de leitura anterior.

Exemplos

O exemplo a seguir mostra como ler de um arquivo de forma assíncrona. O exemplo usa a FileStream classe , que deriva da Stream classe .

using System;
using System.Text;
using System.Threading.Tasks;
using System.Windows;
using System.Windows.Controls;
using System.IO;

namespace WpfApplication1
{
    public partial class MainWindow : Window
    {
        public MainWindow()
        {
            InitializeComponent();
        }

        private async void Button_Click(object sender, RoutedEventArgs e)
        {
            string filename = @"c:\Temp\userinputlog.txt";
            byte[] result;

            using (FileStream SourceStream = File.Open(filename, FileMode.Open))
            {
                result = new byte[SourceStream.Length];
                await SourceStream.ReadAsync(result, 0, (int)SourceStream.Length);
            }

            UserInput.Text = System.Text.Encoding.ASCII.GetString(result);
        }
    }
}

Imports System.IO
Imports System.Text

Class MainWindow
    Private Async Sub Button_Click(sender As Object, e As RoutedEventArgs)
        Dim filename As String = "c:\Temp\userinputlog.txt"

        Dim result As Byte()

        Using SourceStream As FileStream = File.Open(filename, FileMode.Open)
            result = New Byte(SourceStream.Length - 1) {}
            Await SourceStream.ReadAsync(result, 0, CType(SourceStream.Length, Integer))
        End Using

        UserInput.Text = System.Text.Encoding.ASCII.GetString(result)
    End Sub
End Class

Comentários

O ReadAsync método permite que você execute operações de E/S com uso intensivo de recursos sem bloquear o thread main. Essa consideração sobre o desempenho é particularmente importante em um aplicativo da Microsoft Store 8.x ou aplicativo de desktop em que uma operação demorada de fluxo pode bloquear o thread de interface do usuário e fazer seu aplicativo parecer como se não estivesse funcionando. Os métodos assíncronos são usados em conjunto com as async palavras-chave e await no Visual Basic e no C#.

Use a CanRead propriedade para determinar se a instância atual dá suporte à leitura.

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 Read(Byte[], Int32, Int32).

ReadAsync(Byte[], Int32, Int32, CancellationToken)

Origem:

Stream.cs

Lê de forma assíncrona uma sequência de bytes do fluxo atual, avança a posição no fluxo até o número de bytes lidos e monitora as solicitações de cancelamento.

public:
 virtual System::Threading::Tasks::Task<int> ^ ReadAsync(cli::array <System::Byte> ^ buffer, int offset, int count, System::Threading::CancellationToken cancellationToken);

public virtual System.Threading.Tasks.Task<int> ReadAsync (byte[] buffer, 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>

Public Overridable Function ReadAsync (buffer As Byte(), offset As Integer, count As Integer, cancellationToken As CancellationToken) As Task(Of Integer)

Parâmetros

buffer

Byte[]

O buffer no qual os dados serão gravados.

offset

Int32

O deslocamento de bytes no buffer no qual será iniciada a gravação de dados no fluxo.

count

Int32

O número máximo de bytes a serem lidos.

cancellationToken

CancellationToken

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

Retornos

Task<Int32>

Uma tarefa que representa a operação de leitura assíncrona. O valor do parâmetro TResult contém o número total de bytes lidos no buffer. O valor do resultado pode ser menor do que o número de bytes solicitados se o número de bytes atualmente disponível for menor que o número solicitado ou pode ser 0 (zero) se count for 0 ou se o final do fluxo tiver sido atingido.

Exceções

ArgumentNullException

buffer é null.

ArgumentOutOfRangeException

offset ou count é negativo.

ArgumentException

A soma de offset e count é maior que o tamanho do buffer.

NotSupportedException

Não há suporte para leitura no fluxo.

ObjectDisposedException

O fluxo foi descartado.

InvalidOperationException

O fluxo está sendo usado no momento por uma operação de leitura anterior.

OperationCanceledException

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

Comentários

O ReadAsync método permite que você execute operações de E/S com uso intensivo de recursos sem bloquear o thread main. Essa consideração sobre o desempenho é particularmente importante em um aplicativo da Microsoft Store 8.x ou aplicativo de desktop em que uma operação demorada de fluxo pode bloquear o thread de interface do usuário e fazer seu aplicativo parecer como se não estivesse funcionando. Os métodos assíncronos são usados em conjunto com as async palavras-chave e await no Visual Basic e no C#.

Use a CanRead propriedade para determinar se a instância atual dá suporte à leitura.

Se a operação for cancelada antes de ser concluída, a tarefa retornada conterá o Canceled valor da Status propriedade .

Para obter um exemplo, consulte a ReadAsync(Byte[], Int32, Int32) sobrecarga.

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 Read(Byte[], Int32, Int32).

Confira também

• Cancelamento