StringReader.ReadAsync Метод

Определение

Пространство имен:
System.IO
Сборка:
netstandard.dll
Сборки:
mscorlib.dll, System.IO.dll
Сборка:
mscorlib.dll
Сборка:
System.IO.dll

Перегрузки

Имя Описание
ReadAsync(Memory<Char>, CancellationToken)

Асинхронно считывает все символы из входной строки, начиная с текущей позиции, и перемещает текущую позицию в конец входной строки.
ReadAsync(Char[], Int32, Int32)

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

ReadAsync(Memory<Char>, CancellationToken)

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

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>

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

Исключения

OperationCanceledException

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

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

ReadAsync(Char[], Int32, Int32)

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

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

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

Примеры

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

using System;
using System.IO;

namespace ConsoleApplication
{
    class Program
    {
        static void Main(string[] args)
        {
            ReadCharacters();
        }

        static async void ReadCharacters()
        {
            string stringToRead = "Some characters to read but not all";
            char[] charsRead = new char[stringToRead.Length];

            using (StringReader reader = new StringReader(stringToRead))
            {
                await reader.ReadAsync(charsRead, 0, 23);
                Console.WriteLine(charsRead);
            }
        }
    }
}
// The example displays the following output:
// Some characters to read
//

Imports System.IO

Module Module1

    Sub Main()
        ReadCharacters()
    End Sub

    Async Sub ReadCharacters()
        Dim stringToRead = "Some characters to read but not all"
        Dim charsRead(stringToRead.Length) As Char

        Using reader As StringReader = New StringReader(stringToRead)
            Await reader.ReadAsync(charsRead, 0, 23)
            Console.WriteLine(charsRead)
        End Using
    End Sub

End Module
' The example displays the following output:
' Some characters to read
'

Комментарии

Задача завершается после того, как число символов, указанных count параметром, считывается или заканчивается строка.

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

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