PipeReader.CopyToAsync Method

Definition

Namespace:

System.IO.Pipelines

Assembly:

System.IO.Pipelines.dll

Package:

System.IO.Pipelines v9.0.0-preview.3.24172.9

Overloads

CopyToAsync(PipeWriter, CancellationToken)	Asynchronously reads the bytes from the PipeReader and writes them to the specified PipeWriter, using a specified buffer size and cancellation token.
CopyToAsync(Stream, CancellationToken)	Asynchronously reads the bytes from the PipeReader and writes them to the specified stream, using a specified cancellation token.

CopyToAsync(PipeWriter, CancellationToken)

Source:

PipeReader.cs

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

public virtual System.Threading.Tasks.Task CopyToAsync (System.IO.Pipelines.PipeWriter destination, System.Threading.CancellationToken cancellationToken = default);

abstract member CopyToAsync : System.IO.Pipelines.PipeWriter * System.Threading.CancellationToken -> System.Threading.Tasks.Task
override this.CopyToAsync : System.IO.Pipelines.PipeWriter * System.Threading.CancellationToken -> System.Threading.Tasks.Task

Public Overridable Function CopyToAsync (destination As PipeWriter, Optional cancellationToken As CancellationToken = Nothing) As Task

Parameters

destination

PipeWriter

The pipe writer to which the contents of the current 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.

CopyToAsync(Stream, CancellationToken)

Source:

PipeReader.cs

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

public virtual System.Threading.Tasks.Task CopyToAsync (System.IO.Stream destination, System.Threading.CancellationToken cancellationToken = default);

abstract member CopyToAsync : System.IO.Stream * System.Threading.CancellationToken -> System.Threading.Tasks.Task
override this.CopyToAsync : System.IO.Stream * System.Threading.CancellationToken -> System.Threading.Tasks.Task

Public Overridable Function CopyToAsync (destination As Stream, Optional cancellationToken As CancellationToken = Nothing) As Task

Parameters

destination

Stream

The stream to which the contents of the current 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.