如何等待来自 IAsyncEnumerable<> 的所有结果？

Question

我正在修改 C# 8.0 中的新 IAsyncEnumerable<T> 内容。假设我在某处想使用某种方法：

public IAsyncEnumerable<T> SomeBlackBoxFunctionAsync<T>(...) { ... }

我知道我可以将它与await foreach... 语法一起使用。但是，假设我的消费者需要从该函数获得所有结果，然后才能继续。在继续之前等待所有结果的最佳语法是什么？换句话说，我希望能够执行以下操作：

// but that extension - AllResultsAsync() - doesn't exist :-/
List<T> myList = await SomeBlackBoxFunctionAsync<T>().AllResultsAsync(); 

这样做的正确方法是什么？

Answer 1

首先警告：根据定义，异步流可​​能永远不会结束并一直产生结果，直到应用程序终止。这已经在例如 SignalR 或 gRPC 中使用。轮询循环也以这种方式工作。

在异步流上使用 ToListAsync 可能会产生意想不到的后果。

---

System.Linq.Async 包已经提供了这样的运算符。

通过ToListAsync 可以使用整个流。代码*看似简单，但隐藏了一些有趣的问题：

public static ValueTask<List<TSource>> ToListAsync<TSource>(this IAsyncEnumerable<TSource> source, CancellationToken cancellationToken = default)
{
    if (source == null)
        throw Error.ArgumentNull(nameof(source));

    if (source is IAsyncIListProvider<TSource> listProvider)
        return listProvider.ToListAsync(cancellationToken);

    return Core(source, cancellationToken);

    static async ValueTask<List<TSource>> Core(IAsyncEnumerable<TSource> source, CancellationToken cancellationToken)
    {
        var list = new List<TSource>();

        await foreach (var item in source.WithCancellation(cancellationToken).ConfigureAwait(false))
        {
            list.Add(item);
        }

        return list;
    }
}

首先，它返回一个ValueTask。其次，它确保观察到取消并使用ConfigureAwait(false)，以防止死锁。最后，如果源已经提供了自己的ToListAsync 实现，则运营商会遵照执行。

Answer 2

作为一个选项，您可以使用ToArrayAsync 扩展方法，在System.Linq.Async 包中定义

public static ValueTask<TSource[]> ToArrayAsync<TSource>(this IAsyncEnumerable<TSource> source, CancellationToken cancellationToken = default)

根据定义，它扩展了IAsyncEnumerable 接口

Answer 3

根据@DmitryBychenko 的评论，我写了一个扩展来做我想要的：

    public static async Task<ICollection<T>> AllResultsAsync<T>(this IAsyncEnumerable<T> asyncEnumerable)
    {
        if (null == asyncEnumerable)
            throw new ArgumentNullException(nameof(asyncEnumerable));  

        var list = new List<T>();
        await foreach (var t in asyncEnumerable)
        {
            list.Add(t);
        }

        return list;
    }

我只是有点惊讶这不是 C# 8.0 原生提供的......这似乎是一个非常明显的需求。