StreamPipeExtensions.CopyToAsync Method

Definition

Namespace:

System.IO.Pipelines

Assembly:

System.IO.Pipelines.dll

Package:

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

Source:

StreamPipeExtensions.cs

Asynchronously reads the bytes from the Stream and writes them to the specified PipeWriter, using a cancellation token.

public static System.Threading.Tasks.Task CopyToAsync (this System.IO.Stream source, System.IO.Pipelines.PipeWriter destination, System.Threading.CancellationToken cancellationToken = default);

static member CopyToAsync : System.IO.Stream * System.IO.Pipelines.PipeWriter * System.Threading.CancellationToken -> System.Threading.Tasks.Task

<Extension()>
Public Function CopyToAsync (source As Stream, destination As PipeWriter, Optional cancellationToken As CancellationToken = Nothing) As Task

Parameters

source

Stream

The stream from which the contents of the current stream will be copied.

destination

PipeWriter

The writer to which the contents of the source stream will be copied.

cancellationToken

CancellationToken

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

Returns

Task

A task that represents the asynchronous copy operation.

Exceptions

OperationCanceledException

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