File.ReadLinesAsync Метод

Определение

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

System.IO

Сборка:

System.Runtime.dll

Перегрузки

ReadLinesAsync(String, CancellationToken)	Асинхронно считывает строки файла.
ReadLinesAsync(String, Encoding, CancellationToken)	Асинхронно считывает строки файла с указанной кодировкой.

ReadLinesAsync(String, CancellationToken)

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

File.cs

Асинхронно считывает строки файла.

C#

public static System.Collections.Generic.IAsyncEnumerable<string> ReadLinesAsync (string path, System.Threading.CancellationToken cancellationToken = default);

Параметры

path

String

Файл, который нужно прочитать.

cancellationToken

CancellationToken

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

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

IAsyncEnumerable<String>

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

Исключения

OperationCanceledException

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

Комментарии

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

ReadLinesAsync(String, Encoding, CancellationToken)

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

File.cs

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

C#

public static System.Collections.Generic.IAsyncEnumerable<string> ReadLinesAsync (string path, System.Text.Encoding encoding, System.Threading.CancellationToken cancellationToken = default);

Параметры

path

String

Файл, который нужно прочитать.

encoding

Encoding

Кодировка, примененная к содержимому файла.

cancellationToken

CancellationToken

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

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

IAsyncEnumerable<String>

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

Исключения

OperationCanceledException

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

Комментарии

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