Note

Access to this page requires authorization. You can try signing in or .

Access to this page requires authorization. You can try .

PipeReader.ReadAsync(CancellationToken) Method

Definition

Namespace:
System.IO.Pipelines
Assembly:
System.IO.Pipelines.dll
Package:
System.IO.Pipelines v11.0.0-preview.5.26302.115
Source:
PipeReader.cs
Source:
PipeReader.cs
Source:
PipeReader.cs
Source:
PipeReader.cs
Source:
PipeReader.cs
Source:
PipeReader.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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

A ValueTask<TResult> representing the asynchronous read operation.

Exceptions

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

Applies to


Feedback

Was this page helpful?