CryptoStream.ReadAsync Метод

Определение

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

System.Security.Cryptography

Сборки:

netstandard.dll, System.Security.Cryptography.dll

Перегрузки

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

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

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

CryptoStream.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 (ноль), если достигнут конец потока.

Исключения

ArgumentNullException

buffer равно null.

ArgumentOutOfRangeException

offset или count отрицательный.

ArgumentException

offset Сумма и count больше длины буфера.

NotSupportedException

Поток не поддерживает чтение.

ObjectDisposedException

Поток удален.

InvalidOperationException

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

OperationCanceledException

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

Комментарии

Это важно

Начиная с .NET 6 этот метод может не считывать столько байтов, сколько было запрошено. Дополнительные сведения см. в разделе "Частичные и нулевые байты" в DeflateStream, GZipStream и CryptoStream.

Чтобы приостановить выполнение метода до завершения задачи, необходимо перед вызовом оператора ReadAsyncawait (C#) или Await (Visual Basic). Дополнительные сведения см. в статье асинхронное программирование (C#) или асинхронное программирование с помощью Async и Await (Visual Basic).

Если операция отменена до завершения, возвращаемая задача содержит Canceled значение свойства Status .

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

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

• Отмена в управляемых потоках

ReadAsync(Memory<Byte>, CancellationToken)

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

CryptoStream.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>

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

Исключения

NotSupportedException

Связанный CryptoStreamMode с текущим CryptoStream объектом объект не соответствует базовому потоку. Например, это исключение возникает при использовании Read только в базовом потоке, который записывается только.

OperationCanceledException

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

Комментарии

Начиная с .NET 6 этот метод может не считывать столько байтов, сколько было запрошено. Дополнительные сведения см. в разделе "Частичные и нулевые байты" в DeflateStream, GZipStream и CryptoStream.