TaskAsyncEnumerableExtensions.WithCancellation<T> 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.
Sets the CancellationToken to be passed to GetAsyncEnumerator(CancellationToken) when iterating.
public:
generic <typename T>
[System::Runtime::CompilerServices::Extension]
static System::Runtime::CompilerServices::ConfiguredCancelableAsyncEnumerable<T> WithCancellation(System::Collections::Generic::IAsyncEnumerable<T> ^ source, System::Threading::CancellationToken cancellationToken);C#
public static System.Runtime.CompilerServices.ConfiguredCancelableAsyncEnumerable<T> WithCancellation<T>(this System.Collections.Generic.IAsyncEnumerable<T> source, System.Threading.CancellationToken cancellationToken);static member WithCancellation : System.Collections.Generic.IAsyncEnumerable<'T> * System.Threading.CancellationToken -> System.Runtime.CompilerServices.ConfiguredCancelableAsyncEnumerable<'T><Extension()>
Public Function WithCancellation(Of T) (source As IAsyncEnumerable(Of T), cancellationToken As CancellationToken) As ConfiguredCancelableAsyncEnumerable(Of T)- T
The type of the objects being iterated.
- source
- IAsyncEnumerable<T>
The source enumerable being iterated.
- cancellationToken
- CancellationToken
The CancellationToken to use.
The configured enumerable.
| Product | Versions |
|---|---|
| .NET | Core 3.0, Core 3.1, 5, 6, 7, 8, 9, 10 |
| .NET Standard | 2.0 (package-provided), 2.1 |
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: