StringReader.ReadAsync Método

Definição

Namespace:

System.IO

Assembly:

System.Runtime.dll

Sobrecargas

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ê todos os caracteres da cadeia de caracteres de entrada, começando na posição atual, e avança a posição atual para o final da cadeia de caracteres de entrada.

ReadAsync(Char[], Int32, Int32)

Origem:

StringReader.cs

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);

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 origem atual.

index

Int32

A posição em buffer na qual a gravação será iniciada.

count

Int32

O número máximo de caracteres a serem lidos. Se o final da cadeia de caracteres for atingido antes que o número especificado de caracteres seja gravado no buffer, o método será retornado.

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 poderá ser menor que o número de bytes solicitados se o número de bytes disponíveis no momento for menor que o número solicitado ou poderá ser 0 (zero) se o final da cadeia de caracteres foi atingido.

Exceções

ArgumentNullException

buffer é null.

ArgumentOutOfRangeException

index ou count é negativo.

ArgumentException

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

ObjectDisposedException

O leitor de cadeia de caracteres foi descartado.

InvalidOperationException

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

Exemplos

O exemplo a seguir mostra como ler os primeiros 23 caracteres de uma cadeia de caracteres de forma assíncrona.

using System;
using System.IO;

namespace ConsoleApplication
{
    class Program
    {
        static void Main(string[] args)
        {
            ReadCharacters();
        }

        static async void ReadCharacters()
        {
            string stringToRead = "Some characters to read but not all";
            char[] charsRead = new char[stringToRead.Length];

            using (StringReader reader = new StringReader(stringToRead))
            {
                await reader.ReadAsync(charsRead, 0, 23);
                Console.WriteLine(charsRead);
            }
        }
    }
}
// The example displays the following output:
// Some characters to read
//

Imports System.IO

Module Module1

    Sub Main()
        ReadCharacters()
    End Sub

    Async Sub ReadCharacters()
        Dim stringToRead = "Some characters to read but not all"
        Dim charsRead(stringToRead.Length) As Char

        Using reader As StringReader = New StringReader(stringToRead)
            Await reader.ReadAsync(charsRead, 0, 23)
            Console.WriteLine(charsRead)
        End Using
    End Sub

End Module
' The example displays the following output:
' Some characters to read
'

Comentários

A tarefa é concluída depois que o número de caracteres especificado pelo count parâmetro é lido ou o final da cadeia de caracteres é 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).

ReadAsync(Memory<Char>, CancellationToken)

Origem:

StringReader.cs

Lê todos os caracteres da cadeia de caracteres de entrada, começando na posição atual, e avança a posição atual para o final da cadeia de caracteres de entrada.

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 este método é retornado, contém os caracteres lidos da origem atual.

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 do parâmetro TResult contém o número total de caracteres lidos no buffer.

Exceções

OperationCanceledException

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