Stream.ReadAsync Метод

Определение

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

System.IO

Сборки:

netstandard.dll, System.Runtime.dll

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

Перегрузки

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

ReadAsync(Memory<Byte>, CancellationToken)

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

Stream.cs

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

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

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

Public Overridable 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 (ноль), если длина буфера равна 0 или если конец потока достигнут.

Исключения

OperationCanceledException

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

Комментарии

Этот ReadAsync метод позволяет выполнять операции ввода-вывода с большим объемом ресурсов, не блокируя основной поток. Это особенно важно в приложении для Магазина Windows 8.x или классическом приложении, где времязатратная операция потока может заблокировать поток пользовательского интерфейса и создать впечатление, что приложение не работает. Асинхронные методы используются в сочетании с asyncawait ключевыми словами в Visual Basic и C#.

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

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

Пример см. в разделе перегрузки ReadAsync(Byte[], Int32, Int32) .

ReadAsync(Byte[], Int32, Int32)

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

Stream.cs

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

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

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

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

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

Параметры

buffer

Byte[]

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

offset

Int32

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

count

Int32

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

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

Task<Int32>

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

Исключения

ArgumentNullException

buffer равно null.

ArgumentOutOfRangeException

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

ArgumentException

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

NotSupportedException

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

ObjectDisposedException

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

InvalidOperationException

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

Примеры

В следующем примере показано, как асинхронно считывать из файла. В примере используется класс, производный FileStream от Stream класса.

using System;
using System.Text;
using System.Threading.Tasks;
using System.Windows;
using System.Windows.Controls;
using System.IO;

namespace WpfApplication1
{
    public partial class MainWindow : Window
    {
        public MainWindow()
        {
            InitializeComponent();
        }

        private async void Button_Click(object sender, RoutedEventArgs e)
        {
            string filename = @"c:\Temp\userinputlog.txt";
            byte[] result;

            using (FileStream SourceStream = File.Open(filename, FileMode.Open))
            {
                result = new byte[SourceStream.Length];
                await SourceStream.ReadAsync(result, 0, (int)SourceStream.Length);
            }

            UserInput.Text = System.Text.Encoding.ASCII.GetString(result);
        }
    }
}

Imports System.IO
Imports System.Text

Class MainWindow
    Private Async Sub Button_Click(sender As Object, e As RoutedEventArgs)
        Dim filename As String = "c:\Temp\userinputlog.txt"

        Dim result As Byte()

        Using SourceStream As FileStream = File.Open(filename, FileMode.Open)
            result = New Byte(SourceStream.Length - 1) {}
            Await SourceStream.ReadAsync(result, 0, CType(SourceStream.Length, Integer))
        End Using

        UserInput.Text = System.Text.Encoding.ASCII.GetString(result)
    End Sub
End Class

Комментарии

Этот ReadAsync метод позволяет выполнять операции ввода-вывода с большим объемом ресурсов, не блокируя основной поток. Это особенно важно в приложении для Магазина Windows 8.x или классическом приложении, где времязатратная операция потока может заблокировать поток пользовательского интерфейса и создать впечатление, что приложение не работает. Асинхронные методы используются в сочетании с asyncawait ключевыми словами в Visual Basic и C#.

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

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

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

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

Stream.cs

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

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

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

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

Public Overridable 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 (ноль), если count значение равно 0 или если конец потока достигнут.

Исключения

ArgumentNullException

buffer равно null.

ArgumentOutOfRangeException

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

ArgumentException

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

NotSupportedException

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

ObjectDisposedException

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

InvalidOperationException

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

OperationCanceledException

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

Комментарии

Этот ReadAsync метод позволяет выполнять операции ввода-вывода с большим объемом ресурсов, не блокируя основной поток. Это особенно важно в приложении для Магазина Windows 8.x или классическом приложении, где времязатратная операция потока может заблокировать поток пользовательского интерфейса и создать впечатление, что приложение не работает. Асинхронные методы используются в сочетании с asyncawait ключевыми словами в Visual Basic и C#.

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

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

Пример см. в разделе перегрузки ReadAsync(Byte[], Int32, Int32) .

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

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

• Отмена