TextReader.ReadAsync Метод

  • Ссылка

Определение

Пространство имен:
System.IO
Сборка:
System.Runtime.dll
Сборка:
System.Runtime.Extensions.dll
Сборка:
netstandard.dll
Сборка:
System.IO.dll
Сборка:
mscorlib.dll

Перегрузки

ReadAsync(Memory<Char>, CancellationToken)

Считывает символы из текущего потока в блок памяти в асинхронном режиме.
ReadAsync(Char[], Int32, Int32)

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

ReadAsync(Memory<Char>, CancellationToken)

Исходный код:
TextReader.cs
Исходный код:
TextReader.cs
Исходный код:
TextReader.cs

Считывает символы из текущего потока в блок памяти в асинхронном режиме.

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

Параметры

buffer
Memory<Char>

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

cancellationToken
CancellationToken

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

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

ValueTask<Int32>

Задача для значения, представляющая асинхронную операцию чтения. Параметр типа содержит число символов, которые были считаны, или значение 0, если к концу потока не было считано никаких данных. Это число будет не больше длины buffer в зависимости от доступности данных в потоке.

Исключения

OperationCanceledException

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

Применяется к

ReadAsync(Char[], Int32, Int32)

Исходный код:
TextReader.cs
Исходный код:
TextReader.cs
Исходный код:
TextReader.cs

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

public:
 virtual System::Threading::Tasks::Task<int> ^ ReadAsync(cli::array <char> ^ buffer, int index, int count);
public virtual System.Threading.Tasks.Task<int> ReadAsync (char[] buffer, int index, int count);
[System.Runtime.InteropServices.ComVisible(false)]
public virtual System.Threading.Tasks.Task<int> ReadAsync (char[] buffer, int index, int count);
abstract member ReadAsync : char[] * int * int -> System.Threading.Tasks.Task<int>
override this.ReadAsync : char[] * int * int -> System.Threading.Tasks.Task<int>
[<System.Runtime.InteropServices.ComVisible(false)>]
abstract member ReadAsync : char[] * int * int -> System.Threading.Tasks.Task<int>
override this.ReadAsync : char[] * int * int -> System.Threading.Tasks.Task<int>
Public Overridable 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 (нулю), если был достигнут конец текста.

Атрибуты
ComVisibleAttribute

Исключения

ArgumentNullException

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

ArgumentOutOfRangeException

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

ArgumentException

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

ObjectDisposedException

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

InvalidOperationException

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

Комментарии

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

Класс TextReader представляет собой абстрактный класс. Следовательно, в коде экземпляр этого объекта не создается. Пример использования метода см. в ReadAsync этом методе StreamReader.ReadAsync .

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

См. также раздел

Применяется к