TextReader.ReadBlockAsync Метод

Определение

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

System.IO

Сборки:

netstandard.dll, System.Runtime.dll

Перегрузки

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

ReadBlockAsync(Memory<Char>, CancellationToken)

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

TextReader.cs

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

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

abstract member ReadBlockAsync : Memory<char> * System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask<int>
override this.ReadBlockAsync : Memory<char> * System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask<int>

Public Overridable Function ReadBlockAsync (buffer As Memory(Of Char), Optional cancellationToken As CancellationToken = Nothing) As ValueTask(Of Integer)

Параметры

buffer

Memory<Char>

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

cancellationToken

CancellationToken

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

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

ValueTask<Int32>

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

Исключения

OperationCanceledException

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

ReadBlockAsync(Char[], Int32, Int32)

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

TextReader.cs

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

public:
 virtual System::Threading::Tasks::Task<int> ^ ReadBlockAsync(cli::array <char> ^ buffer, int index, int count);

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

abstract member ReadBlockAsync : char[] * int * int -> System.Threading.Tasks.Task<int>
override this.ReadBlockAsync : char[] * int * int -> System.Threading.Tasks.Task<int>

Public Overridable Function ReadBlockAsync (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

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

Комментарии

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

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

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

• System.IO.StreamReader.ReadBlockAsync(System.Char[],System.Int32,System.Int32)
• System.IO.StringReader.ReadBlockAsync(System.Char[],System.Int32,System.Int32)
• Файловый и потоковый ввод-вывод
• Практическое руководство. Чтение текста из файла
• Практическое руководство. Запись текста в файл