Csharp 嵌套 IAsyncEnumerable 函数需要 EnumeratorCancellation 属性吗

您可以考虑采用System.Linq.Async库中使用的模式.例如，Where LINQ运算符:

public static IAsyncEnumerable<TSource> Where<TSource>(
    this IAsyncEnumerable<TSource> source, Func<TSource, bool> predicate)
{
    if (source == null)
        throw Error.ArgumentNull(nameof(source));
    if (predicate == null)
        throw Error.ArgumentNull(nameof(predicate));

    return Core(source, predicate);

    static async IAsyncEnumerable<TSource> Core(IAsyncEnumerable<TSource> source,
        Func<TSource, bool> predicate,
        [EnumeratorCancellation] CancellationToken cancellationToken = default)
    {
        await foreach (var element in source.WithCancellation(cancellationToken)
            .ConfigureAwait(false))
        {
            if (predicate(element))
            {
                yield return element;
            }
        }
    }
}

如您所见，Where操作符的公共签名不包括CancellationToken参数.调用方始终可以使用WithCancellation运算符将CancellationToken附加到异步序列，因此包括参数是多余的.

另一方面，运算符的本地Core实现确实包括CancellationToken参数，该参数也用EnumeratorCancellation属性装饰.当调用者使用Where并使用WithCancellation附加令牌时，由于EnumeratorCancellation属性，该令牌将自动传递给Core实现.

So the general rule is:返回IAsyncEnumerable<T>的方法只有在用async实现的情况下才应该包括CancellationToken参数，在这种情况下，参数也应该用EnumeratorCancellation属性修饰.

理想情况下，返回IAsyncEnumerable<T>的公共API不应该用async实现.这是因为向调用者提供两种不同的选项来传递令牌，无论是直接传递还是通过WithCancellation传递，都会造成混乱，而不会给API增加任何值.有关not要做什么的示例，请参阅ChannelReader<T>.ReadAllAsync API的第implementation部分.

为了直接回答您的问题，MyOuterFunctionAsync将正确识别作为参数传递的CancellationToken，但如果CancellationToken与WithCancellation运算符一起传递，则不会.例如，如果是var sequence = client.MyOuterFunctionAsync(CancellationToken.None).WithCancellation(token);，则token将被忽略.为了获得正确的行为，您必须在MyLocalFunction中添加EnumeratorCancellation属性.