PipeReader.CopyToAsync Method
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.
CopyToAsync(PipeWriter, CancellationToken) |
Asynchronously reads the bytes from the PipeReader and writes them to the specified PipeWriter, using a specified cancellation token. |
CopyToAsync(Stream, CancellationToken) |
Asynchronously reads the bytes from the PipeReader and writes them to the specified stream, using a specified cancellation token. |
- Source:
- PipeReader.cs
- Source:
- PipeReader.cs
- Source:
- PipeReader.cs
Asynchronously reads the bytes from the PipeReader and writes them to the specified PipeWriter, using a specified 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
A task that represents the asynchronous copy operation.
Exceptions
The cancellation token was canceled. This exception is stored into the returned task.
Applies to
.NET 9 and other versions
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) |
- Source:
- PipeReader.cs
- Source:
- PipeReader.cs
- 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
A task that represents the asynchronous copy operation.
Exceptions
The cancellation token was canceled. This exception is stored into the returned task.
Applies to
.NET 9 and other versions
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) |
.NET feedback
.NET is an open source project. Select a link to provide feedback: