StringReader.ReadAsync Método

Definição

Sobrecargas

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.Asynchronously reads all the characters from the input string, starting at the current position, and advances the current position to the end of the input string.

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.Reads a specified maximum number of characters from the current string asynchronously and writes the data to a buffer, beginning at the specified index.

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.Asynchronously reads all the characters from the input string, starting at the current position, and advances the current position to the end of the input string.

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.When this method returns, contains the characters read from the current source.

cancellationToken
CancellationToken

O token a se monitorar para solicitações de cancelamento.The token to monitor for cancellation requests. O valor padrão é None.The default value is None.

Retornos

ValueTask<Int32>

Uma tarefa que representa a operação de leitura assíncrona.A task that represents the asynchronous read operation. O valor do parâmetro TResult contém o número total de caracteres lidos no buffer.The value of the TResult parameter contains the total number of characters read into the buffer.

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.Reads a specified maximum number of characters from the current string asynchronously and writes the data to a buffer, beginning at the specified index.

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 origem atual.When this method returns, contains the specified character array with the values between index and (index + count - 1) replaced by the characters read from the current source.

index
Int32

A posição em buffer na qual a gravação será iniciada.The position in buffer at which to begin writing.

count
Int32

O número máximo de caracteres a serem lidos.The maximum number of characters to read. 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.If the end of the string is reached before the specified number of characters is written into the buffer, the method returns.

Retornos

Task<Int32>

Uma tarefa que representa a operação de leitura assíncrona.A task that represents the asynchronous read operation. O valor do parâmetro TResult contém o número total de bytes lidos no buffer.The value of the TResult parameter contains the total number of bytes read into the 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.The result value can be less than the number of bytes requested if the number of bytes currently available is less than the requested number, or it can be 0 (zero) if the end of the string has been reached.

Atributos

Exceções

buffer é null.buffer is null.

index ou count é negativo.index or count is negative.

A soma de index e count é maior que o tamanho do buffer.The sum of index and count is larger than the buffer length.

O leitor de cadeia de caracteres foi descartado.The string reader has been disposed.

O leitor está sendo usado no momento por uma operação de leitura anterior.The reader is currently in use by a previous read operation.

Exemplos

O exemplo a seguir mostra como ler os primeiros 23 caracteres de uma cadeia de caracteres de forma assíncrona.The following example shows how to read the first 23 characters of a string asynchronously.

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 fim da cadeia de caracteres é atingido.The task completes after either the number of characters specified by the count parameter are read or the end of the string is reached.

Aplica-se a