IAsyncEnumerable<T> Interface

Definition

Exposes an enumerator that provides asynchronous iteration over values of a specified type.

public interface IAsyncEnumerable<out T>

Type Parameters

T

The type of values to enumerate.

This type parameter is covariant. That is, you can use either the type you specified or any type that is more derived. For more information about covariance and contravariance, see Covariance and Contravariance in Generics.

Methods

GetAsyncEnumerator(CancellationToken)

Returns an enumerator that iterates asynchronously through the collection.

Extension Methods

ConfigureAwait<T>(IAsyncEnumerable<T>, Boolean)

Configures how awaits on the tasks returned from an async iteration will be performed.

ToBlockingEnumerable<T>(IAsyncEnumerable<T>, CancellationToken)

Converts an IAsyncEnumerable<T> instance into an IEnumerable<T> that enumerates elements in a blocking manner.

WithCancellation<T>(IAsyncEnumerable<T>, CancellationToken)

Sets the CancellationToken to be passed to GetAsyncEnumerator(CancellationToken) when iterating.

Applies to

Product Versions
.NET Core 3.0, Core 3.1, 5, 6, 7, 8, 9
.NET Standard 2.0 (package-provided), 2.1