如何在没有异步/等待的情况下返回传播 OperationCanceledException 的已取消 ValueTask<T>？

Question

我正在编写一个返回类型为ValueTask<T> 并接受CancellationToken 的API。如果在调用该方法时CancellationToken 已经被取消，我想返回一个取消的ValueTask<T> (IsCanceled == true)，它会在等待时传播OperationCanceledException。用异步方法做这件事很简单：

async ValueTask<int> MyMethod1(CancellationToken token)
{
    token.ThrowIfCancellationRequested();
    //...
    return 13;
}

ValueTask<int> task = MyMethod1(new CancellationToken(true));
Console.WriteLine($"IsCanceled: {task.IsCanceled}"); // True
await task; // throws OperationCanceledException

我决定切换到非async 实现，但现在我无法重现相同的行为。将Task.FromCanceled 正确包装为已取消的ValueTask<T>，但异常类型为TaskCanceledException，这是不可取的：

ValueTask<int> MyMethod2(CancellationToken token)
{
    if (token.IsCancellationRequested)
        return new ValueTask<int>(Task.FromCanceled<int>(token));
    //...
    return new ValueTask<int>(13);
}

ValueTask<int> task = MyMethod2(new CancellationToken(true));
Console.WriteLine($"IsCanceled: {task.IsCanceled}"); // True
await task; // throws TaskCanceledException (undesirable)

另一个不成功的尝试是包装Task.FromException。这个传播了正确的异常类型，但任务是错误的而不是取消的：

ValueTask<int> MyMethod3(CancellationToken token)
{
    if (token.IsCancellationRequested)
        return new ValueTask<int>(
            Task.FromException<int>(new OperationCanceledException(token)));
    //...
    return new ValueTask<int>(13);
}

ValueTask<int> task = MyMethod3(new CancellationToken(true));
Console.WriteLine($"IsCanceled: {task.IsCanceled}"); // False (undesirable)
await task; // throws OperationCanceledException

这个问题有什么解决方案吗，或者我应该接受我的 API 行为不一致，有时会传播TaskCanceledExceptions（当令牌已经取消时），有时会传播OperationCanceledExceptions（当令牌稍后被取消）？

Try it on Fiddle.

---

更新：作为我试图避免的不一致的一个实际示例，这是一个来自内置 Channel<T> 类的示例：

Channel<int> channel = Channel.CreateUnbounded<int>();

ValueTask<int> task1 = channel.Reader.ReadAsync(new CancellationToken(true));
await task1; // throws TaskCanceledException

ValueTask<int> task2 = channel.Reader.ReadAsync(new CancellationTokenSource(100).Token);
await task2; // throws OperationCanceledException

第一个ValueTask<int> 抛出TaskCanceledException，因为令牌已经被取消。第二个ValueTask<int> 抛出OperationCanceledException，因为令牌在100 毫秒后被取消。

Try it on Fiddle.

Answer 1

这里最好的方法可能是简单地拥有一个您可以遵循的async 辅助方法，这里；即：

ValueTask<int> MyMethod3(CancellationToken token)
{
    if (token.IsCancellationRequested) return Cancelled(token);
    // ... the rest of your non-async code here

    static async ValueTask<int> Cancelled(CancellationToken token)
    {
        token.ThrowIfCancellationRequested();
        // some dummy await, or just suppress the compiler warning about no await
        await Task.Yield(); // should never be reached
        return 0; // should never be reached
    }
}

有第三个​​选项可能会起作用，但它要复杂得多并且不能避免分配（IValueTaskSource<TResult> - 请注意您仍然需要在某个地方存放相关令牌)

运动鞋版本：

---

#pragma warning disable CS1998
static async ValueTask<int> Cancelled(CancellationToken token)
#pragma warning restore CS1998
{
    token.ThrowIfCancellationRequested();
    return 0; // should never be reached
}