PipeReader.ReadAsync(CancellationToken) Method

Definition

Namespace:

System.IO.Pipelines

Assembly:

System.IO.Pipelines.dll

Source:

PipeReader.cs

Asynchronously reads a sequence of bytes from the current PipeReader.

public abstract System.Threading.Tasks.ValueTask<System.IO.Pipelines.ReadResult> ReadAsync (System.Threading.CancellationToken cancellationToken = default);

abstract member ReadAsync : System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask<System.IO.Pipelines.ReadResult>

Public MustOverride Function ReadAsync (Optional cancellationToken As CancellationToken = Nothing) As ValueTask(Of ReadResult)

Parameters

cancellationToken

CancellationToken

The token to monitor for cancellation requests. The default value is default.

Returns

ValueTask<ReadResult>

A ValueTask<TResult> representing the asynchronous read operation.

Exceptions

OperationCanceledException

The cancellation token was canceled. This exception is stored into the returned task.