PipeReader.ReadAsync(CancellationToken) 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.
Asynchronously reads a sequence of bytes from the current PipeReader.
C#
public abstract System.Threading.Tasks.ValueTask<System.IO.Pipelines.ReadResult> ReadAsync(System.Threading.CancellationToken cancellationToken = default);abstract member ReadAsync : System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask<System.IO.Pipelines.ReadResult>Public MustOverride Function ReadAsync (Optional cancellationToken As CancellationToken = Nothing) As ValueTask(Of ReadResult)- cancellationToken
- CancellationToken
The token to monitor for cancellation requests. The default value is default.
A ValueTask<TResult> representing the asynchronous read operation.
The cancellation token was canceled. This exception is stored into the returned task.
| Product | Versions |
|---|---|
| .NET | 8 (package-provided), 9 (package-provided), 9, 10 (package-provided), 10 |
| .NET Standard | 2.0 (package-provided) |
Collaborate with us on GitHub
The source for this content can be found on GitHub, where you can also create and review issues and pull requests. For more information, see our contributor guide.
.NET feedback
.NET is an open source project. Select a link to provide feedback: