PipeReader.ReadAsync(CancellationToken) Method

Reference

Definition

Namespace:: System.IO.Pipelines

Assembly:: System.IO.Pipelines.dll

Package:: System.IO.Pipelines v8.0.0

Package:: System.IO.Pipelines v9.0.0-rc.2.24473.5

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

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.

Applies to

Freigeben über