PipeWriter.CopyFromAsync(Stream, CancellationToken) Method

Reference

Definition

Namespace:: System.IO.Pipelines

Assembly:: System.IO.Pipelines.dll

Package:: System.IO.Pipelines v6.0.0

Package:: System.IO.Pipelines v7.0.0

Package:: System.IO.Pipelines v8.0.0

Package:: System.IO.Pipelines v9.0.0-preview.2.24128.5

Source:: PipeWriter.cs

Source:: PipeWriter.cs

Source:: PipeWriter.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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.

Applies to