StreamPipeExtensions.CopyToAsync Method

Definition

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

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

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

A task that represents the asynchronous copy operation.

Exceptions

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

Applies to

Product Versions
.NET 8 (package-provided), 9 (package-provided), 9
.NET Framework 4.7 (package-provided), 4.7.1 (package-provided), 4.7.2 (package-provided), 4.8 (package-provided)
.NET Standard 2.0 (package-provided)