StreamReader.ReadAsync Метод

Ссылка

Определение

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

Сборка:: System.Runtime.dll

Сборка:: System.Runtime.Extensions.dll

Сборка:: netstandard.dll

Сборка:: System.IO.dll

Сборка:: mscorlib.dll

Важно!

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

Перегрузки

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

ReadAsync(Memory<Char>, CancellationToken)

Исходный код:: StreamReader.cs

Исходный код:: StreamReader.cs

Исходный код:: StreamReader.cs

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

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

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

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

Параметры

buffer: Memory<Char>

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

cancellationToken: CancellationToken

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

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

ValueTask<Int32>

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

Исключения

OperationCanceledException

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

Применяется к

.NET 9 и другие версии

Продукт	Версии
.NET	Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9
.NET Standard	2.1

ReadAsync(Char[], Int32, Int32)

Исходный код:: StreamReader.cs

Исходный код:: StreamReader.cs

Исходный код:: StreamReader.cs

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

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

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

[System.Runtime.InteropServices.ComVisible(false)]
public override System.Threading.Tasks.Task<int> ReadAsync (char[] buffer, int index, int count);

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

[<System.Runtime.InteropServices.ComVisible(false)>]
override this.ReadAsync : char[] * int * int -> System.Threading.Tasks.Task<int>

Public Overrides Function ReadAsync (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 (нулю), если достигнут конец потока.

Атрибуты: ComVisibleAttribute

Исключения

ArgumentNullException

buffer имеет значение null.

ArgumentOutOfRangeException

index или count является отрицательным значением.

ArgumentException

Сумма index и count больше, чем длина буфера.

ObjectDisposedException

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

InvalidOperationException

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

Примеры

В следующем примере показано, как считывать все символы в файле с помощью ReadAsync(Char[], Int32, Int32) метода . Перед добавлением символа в экземпляр StringBuilder класса проверяется, является ли каждый символ буквой, цифрой или пробелом.

using System;
using System.Windows;
using System.IO;
using System.Text;

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

        private async void Button_Click_1(object sender, RoutedEventArgs e)
        {
            string filename = @"C:\Example\existingfile.txt";
            char[] result;
            StringBuilder builder = new StringBuilder();

            using (StreamReader reader = File.OpenText(filename))
            {
                result = new char[reader.BaseStream.Length];
                await reader.ReadAsync(result, 0, (int)reader.BaseStream.Length);
            }

            foreach (char c in result)
            {
                if (char.IsLetterOrDigit(c) || char.IsWhiteSpace(c))
                {
                    builder.Append(c);
                }
            }
            FileOutput.Text = builder.ToString();
        }
    }
}

Imports System.Text
Imports System.IO

Class MainWindow

    Private Async Sub Button_Click_1(sender As Object, e As RoutedEventArgs)
        Dim filename As String = "C:\Example\existingfile.txt"
        Dim result() As Char
        Dim builder As StringBuilder = New StringBuilder()

        Using reader As StreamReader = File.OpenText(filename)
            ReDim result(reader.BaseStream.Length)
            Await reader.ReadAsync(result, 0, reader.BaseStream.Length)
        End Using

        For Each c As Char In result
            If (Char.IsLetterOrDigit(c) Or Char.IsWhiteSpace(c)) Then
                builder.Append(c)
            End If
            Next
        FileOutput.Text = builder.ToString()
    End Sub
End Class

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

Применяется к

.NET 9 и другие версии

Продукт	Версии
.NET	Core 1.0, Core 1.1, Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9
.NET Framework	4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
.NET Standard	1.0, 1.1, 1.2, 1.3, 1.4, 1.5, 1.6, 2.0, 2.1
UWP	10.0

Совместная работа с нами на GitHub

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

Отзыв о .NET

.NET — это проект с открытым исходным кодом. Выберите ссылку, чтобы оставить отзыв:

Открыть проблему с документацией Отзыв о продукте

Фестиваль навыков ИИ

Поделиться через

Определение

Перегрузки

ReadAsync(Memory<Char>, CancellationToken)

Параметры

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

Исключения

Применяется к

ReadAsync(Char[], Int32, Int32)

Параметры

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

Исключения

Примеры

Комментарии

Применяется к