PipeWriter.CopyFromAsync(Stream, CancellationToken) Method

Definition

Namespace:

System.IO.Pipelines

Assembly:

System.IO.Pipelines.dll

Package:

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

Source:

PipeWriter.cs

Asynchronously reads the bytes from the specified stream and writes them to the PipeWriter.

protected internal virtual System.Threading.Tasks.Task CopyFromAsync (System.IO.Stream source, System.Threading.CancellationToken cancellationToken = default);

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

Protected Friend Overridable Function CopyFromAsync (source As Stream, Optional cancellationToken As CancellationToken = Nothing) As Task

Parameters

source

Stream

The stream from which the contents 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.