StreamReader.ReadBlockAsync Метод

Определение

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

System.IO

Сборка:

System.Runtime.dll

Перегрузки

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

ReadBlockAsync(Memory<Char>, CancellationToken)

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

StreamReader.cs

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

public override System.Threading.Tasks.ValueTask<int> ReadBlockAsync (Memory<char> buffer, System.Threading.CancellationToken cancellationToken = default);

Параметры

buffer

Memory<Char>

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

cancellationToken

CancellationToken

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

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

ValueTask<Int32>

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

Исключения

OperationCanceledException

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

ReadBlockAsync(Char[], Int32, Int32)

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

StreamReader.cs

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

public override System.Threading.Tasks.Task<int> ReadBlockAsync (char[] buffer, int index, int count);

Параметры

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

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

Комментарии

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

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