UnmanagedMemoryStream.ReadAsync Метод

Определение

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

System.IO

Сборки:

netstandard.dll, System.Runtime.dll

Перегрузки

Имя	Описание
ReadAsync(Memory<Byte>, CancellationToken)	Асинхронно считывает неуправляемые байты памяти в область памяти.
ReadAsync(Byte[], Int32, Int32, CancellationToken)	Асинхронно считывает указанное число байтов в указанный массив.

ReadAsync(Memory<Byte>, CancellationToken)

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

UnmanagedMemoryStream.cs

Асинхронно считывает неуправляемые байты памяти в область памяти.

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

override this.ReadAsync : Memory<byte> * System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask<int>

Public Overrides Function ReadAsync (buffer As Memory(Of Byte), Optional cancellationToken As CancellationToken = Nothing) As ValueTask(Of Integer)

Параметры

buffer

Memory<Byte>

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

cancellationToken

CancellationToken

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

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

ValueTask<Int32>

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

Исключения

OperationCanceledException

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

ReadAsync(Byte[], Int32, Int32, CancellationToken)

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

UnmanagedMemoryStream.cs

Асинхронно считывает указанное число байтов в указанный массив.

public:
 override System::Threading::Tasks::Task<int> ^ ReadAsync(cli::array <System::Byte> ^ buffer, int offset, int count, System::Threading::CancellationToken cancellationToken);

public override System.Threading.Tasks.Task<int> ReadAsync(byte[] buffer, int offset, int count, System.Threading.CancellationToken cancellationToken);

override this.ReadAsync : byte[] * int * int * System.Threading.CancellationToken -> System.Threading.Tasks.Task<int>

Public Overrides Function ReadAsync (buffer As Byte(), offset As Integer, count As Integer, cancellationToken As CancellationToken) As Task(Of Integer)

Параметры

buffer

Byte[]

Буфер для записи данных в.

offset

Int32

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

count

Int32

Максимальное число байтов для чтения.

cancellationToken

CancellationToken

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

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

Task<Int32>

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

Исключения

OperationCanceledException

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

Комментарии

Если во время операции чтения возникает исключение, оно будет задано как Task.Exception свойство возвращаемой задачи.

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