StringReader.ReadAsync Метод

Определение

Пространство имен:

System.IO

Сборка:

System.Runtime.dll

Перегрузки

ReadAsync(Char[], Int32, Int32)	Асинхронно считывает указанное максимальное количество символов из текущей строки и записывает данные в буфер, начиная с заданного индекса.
ReadAsync(Memory<Char>, CancellationToken)	Асинхронно считывает все символы из входной строки, начиная с текущей позиции, и перемещает текущую позицию в конец входной строки.

ReadAsync(Char[], Int32, Int32)

Исходный код:

StringReader.cs

Асинхронно считывает указанное максимальное количество символов из текущей строки и записывает данные в буфер, начиная с заданного индекса.

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)

Параметры

buffer

Char[]

При возвращении из этого метода содержит указанный массив символов, в котором значения в интервале от index и (index + count - 1) заменены символами, считанными из текущего источника.

index

Int32

Позиция в буфере buffer, с которого начинается запись.

count

Int32

Максимальное число считываемых символов. Если конец строки достигнут, прежде чем в буфер записано указанное количество символов, метод возвращает управление.

Возвращаемое значение

Task<Int32>

Задача, представляющая асинхронную операцию чтения. Значение параметра TResult содержит общее число байтов, считанных в буфер. Значение результата может быть меньше запрошенного числа байтов, если число текущих доступных байтов меньше запрошенного числа, или результат может быть равен 0 (нулю), если был достигнут конец строки.

Исключения

ArgumentNullException

buffer имеет значение null.

ArgumentOutOfRangeException

index или count является отрицательным значением.

ArgumentException

Сумма index и count больше, чем длина буфера.

ObjectDisposedException

Удалено средство чтения строки.

InvalidOperationException

Модуль чтения в настоящее время используется предыдущей операцией чтения.

Примеры

В следующем примере показано, как асинхронно считывать первые 23 символа строки.

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
'

Комментарии

Задача завершается после считывания количества символов, указанного параметром count , или достижения конца строки.

Этот метод сохраняет в задаче все исключения, не относящиеся к использованию, которые может создавать синхронный аналог метода. Если исключение сохраняется в возвращаемой задаче, это исключение будет создано при ожидании задачи. Исключения использования, такие как ArgumentException, по-прежнему создаются синхронно. Хранимые исключения см. в разделе исключения, создаваемые Read(Char[], Int32, Int32).

ReadAsync(Memory<Char>, CancellationToken)

Исходный код:

StringReader.cs

Асинхронно считывает все символы из входной строки, начиная с текущей позиции, и перемещает текущую позицию в конец входной строки.

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)

Параметры

buffer

Memory<Char>

Когда этот метод возвращает управление, содержит символы, считанные из текущего источника.

cancellationToken

CancellationToken

Токен для отслеживания запросов отмены. Значение по умолчанию — None.

Возвращаемое значение

ValueTask<Int32>

Задача, представляющая асинхронную операцию чтения. Значение параметра TResult содержит общее число символов (в байтах), считанных в буфер.

Исключения

OperationCanceledException

Маркер отмены был отменен. Это исключение сохраняется в возвращаемой задаче.