StreamReader.ReadAsync Método

Definição

Namespace:
System.IO
Assembly:
netstandard.dll
Assemblies:
mscorlib.dll, System.IO.dll
Assembly:
mscorlib.dll
Assembly:
System.IO.dll

Sobrecargas

Nome Description
ReadAsync(Memory<Char>, CancellationToken)

Lê de forma assíncrona os caracteres do fluxo atual em um bloco de memória.
ReadAsync(Char[], Int32, Int32)

Lê um número máximo especificado de caracteres do fluxo atual de forma assíncrona e grava os dados em um buffer, começando no índice especificado.

ReadAsync(Memory<Char>, CancellationToken)

Lê de forma assíncrona os caracteres do fluxo atual em um bloco de memória.

public override System.Threading.Tasks.ValueTask<int> ReadAsync(Memory<char> buffer, System.Threading.CancellationToken cancellationToken = default);
override this.ReadAsync : Memory<char> * System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask<int>
Public Overrides Function ReadAsync (buffer As Memory(Of Char), Optional cancellationToken As CancellationToken = Nothing) As ValueTask(Of Integer)

Parâmetros

buffer
Memory<Char>

Quando esse método é retornado, contém o bloco de memória especificado dos caracteres substituídos pelos caracteres lidos da origem atual.

cancellationToken
CancellationToken

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

Retornos

ValueTask<Int32>

Uma tarefa de valor que representa a operação de leitura assíncrona. O valor do parâmetro de tipo da tarefa de valor contém o número de caracteres que foram lidos ou 0 se no final do fluxo e nenhum dado foi lido. O número será menor ou igual ao buffer comprimento, dependendo se os dados estão disponíveis dentro do fluxo.

Exceções

OperationCanceledException

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

Aplica-se a

ReadAsync(Char[], Int32, Int32)

Lê um número máximo especificado de caracteres do fluxo atual de forma assíncrona e grava os dados em um buffer, começando no índice especificado.

public:
 override System::Threading::Tasks::Task<int> ^ ReadAsync(cli::array <char> ^ buffer, int index, int count);
public override System.Threading.Tasks.Task<int> ReadAsync(char[] buffer, int index, int count);
[System.Runtime.InteropServices.ComVisible(false)]
public override System.Threading.Tasks.Task<int> ReadAsync(char[] buffer, int index, int count);
override this.ReadAsync : char[] * int * int -> System.Threading.Tasks.Task<int>
[<System.Runtime.InteropServices.ComVisible(false)>]
override this.ReadAsync : char[] * int * int -> System.Threading.Tasks.Task<int>
Public Overrides Function ReadAsync (buffer As Char(), index As Integer, count As Integer) As Task(Of Integer)

Parâmetros

buffer
Char[]

Quando esse método é retornado, contém a matriz de caracteres especificada com os valores entre index e (index + count - 1) substituídos pelos caracteres lidos da fonte atual.

index
Int32

A posição na buffer qual começar a escrever.

count
Int32

O número máximo de caracteres a serem lidos. Se o final do fluxo for atingido antes que o número especificado de caracteres seja gravado no buffer, o método atual retornará.

Retornos

Task<Int32>

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

Atributos
ComVisibleAttribute

Exceções

ArgumentNullException

buffer é null.

ArgumentOutOfRangeException

index ou count é negativo.

ArgumentException

A soma de index e count é maior que o comprimento do buffer.

ObjectDisposedException

O fluxo foi descartado.

InvalidOperationException

O leitor está atualmente em uso por uma operação de leitura anterior.

Exemplos

O exemplo a seguir mostra como ler todos os caracteres em um arquivo usando o ReadAsync(Char[], Int32, Int32) método. Ele verifica se cada caractere é uma letra, dígito ou espaço em branco antes de adicionar o caractere a uma instância da StringBuilder classe.

using System;
using System.Windows;
using System.IO;
using System.Text;

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

        private async void Button_Click_1(object sender, RoutedEventArgs e)
        {
            string filename = @"C:\Example\existingfile.txt";
            char[] result;
            StringBuilder builder = new StringBuilder();

            using (StreamReader reader = File.OpenText(filename))
            {
                result = new char[reader.BaseStream.Length];
                await reader.ReadAsync(result, 0, (int)reader.BaseStream.Length);
            }

            foreach (char c in result)
            {
                if (char.IsLetterOrDigit(c) || char.IsWhiteSpace(c))
                {
                    builder.Append(c);
                }
            }
            FileOutput.Text = builder.ToString();
        }
    }
}

Imports System.Text
Imports System.IO

Class MainWindow

    Private Async Sub Button_Click_1(sender As Object, e As RoutedEventArgs)
        Dim filename As String = "C:\Example\existingfile.txt"
        Dim result() As Char
        Dim builder As StringBuilder = New StringBuilder()

        Using reader As StreamReader = File.OpenText(filename)
            ReDim result(reader.BaseStream.Length)
            Await reader.ReadAsync(result, 0, reader.BaseStream.Length)
        End Using

        For Each c As Char In result
            If (Char.IsLetterOrDigit(c) Or Char.IsWhiteSpace(c)) Then
                builder.Append(c)
            End If
            Next
        FileOutput.Text = builder.ToString()
    End Sub
End Class

Comentários

A tarefa é concluída depois que o número de caracteres especificado pelo count parâmetro é lido ou o final do fluxo é atingido.

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

Aplica-se a