PipeReader.ReadAtLeastAsync(Int32, 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 System.Threading.Tasks.ValueTask<System.IO.Pipelines.ReadResult> ReadAtLeastAsync (int minimumSize, System.Threading.CancellationToken cancellationToken = default);

member this.ReadAtLeastAsync : int * System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask<System.IO.Pipelines.ReadResult>

Public Function ReadAtLeastAsync (minimumSize As Integer, Optional cancellationToken As CancellationToken = Nothing) As ValueTask(Of ReadResult)

Parameters

minimumSize

Int32

The minimum length that needs to be buffered in order for the call to return.

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.

Remarks

The call returns if the PipeReader has read the minimumSize specified, or is cancelled or completed.