在 C#7 中，如何 "roll my own" 类任务类型与异步一起使用？

Question

C#7 的一个鲜为人知的特性是 "generalized async return types"，Microsoft 将其描述为：

从异步方法返回任务对象可能会在某些路径中引入性能瓶颈。 Task是一个引用类型，所以使用它意味着分配一个对象。如果使用异步修饰符 return 声明的方法是缓存结果，或者同步完成，额外的分配可能会成为代码性能关键部分的重要时间成本。如果这些分配发生在紧密的循环中，它可能会变得非常昂贵。

新的语言特性意味着除了 Task、Task<T> 和 void 之外，异步方法还可以 return 其他类型。 returned 类型仍必须满足异步模式，这意味着必须可以访问 GetAwaiter 方法。作为一个具体示例，ValueTask 类型已添加到 .NET 框架中以利用这一新语言功能：

这听起来不错，但我终其一生都找不到任何不使用标准 ValueTask<T> 类型的示例。我想制作自己的类似任务的类型。具体来说，我想要一种行为类似于 Task<T>，但具有更实用的错误处理风格的类型。

这是我在项目中用于功能性错误处理的类型：

public class Try<T> {
    public T Data { get; }
    public Exception Error { get; }

    public bool HasData => Error == null;
    public bool HasError => Error != null;

    public Try(T data) {
        Data = data;
    }

    public Try(Exception error) {
        Error = error;
    }
}

我认为我的自定义等待类型应该如下所示：

public class TryTask<T> : Task<Try<T>> {

    public TryTask(Func<Try<T>> func)
        : base(func) { }

    //GetAwaiter is defined on base type, so we should be okay there
}

这一切都可以编译，直到我尝试将它用作异步 return 类型：

async TryTask<int> DoWhatever() {
    return await new TryTask<int>(() => new Try<int>(1));
}

此方法会给编译器报错异步方法的return类型必须是void、Task或Task。

如何编译这个或类似的东西？

更新：

确认一下，我使用的是 3 月 7 日发布的 VS 2017，我可以在我的项目中使用其他 C#7 功能，例如本地函数。

我也尝试过使用 ValueTask，但遇到了同样的编译器错误。

static async ValueTask<int> DoWhatever() {
    return await new ValueTask<int>(1);          
}

这是另一个 post，它阐明了正在发生的事情。

显然需要定义一个单独的 "method builder" 类型，并且需要将特殊属性应用于等待类型。我不知道我是否真的有时间深入研究这个。它看起来更像是元编程黑客而不是 "language feature".

Answer 1

我还没有找到任何好的教程。但是您可以查看 compiler unittests 创建此类类似任务的类型（查找“[AsyncMethodBuilder”）。

起点是创建一个类型并将其标记为类似任务的类型，并使用 [AsyncMethodBuilder(typeof(MyTaskBuilder))] 之类的属性。然后你需要定义你自己的 MyTaskBuilder 类型。它必须实现某种模式（见下文）。这与支持常规 Task.

的常规 AsyncMethodBuilder 类型实现的模式相同

class MyTaskBuilder
{
    public static MyTaskBuilder Create() => null;
    public void Start<TStateMachine>(ref TStateMachine stateMachine) where TStateMachine : IAsyncStateMachine { }
    public void SetStateMachine(IAsyncStateMachine stateMachine) { }
    public void SetResult() { }
    public void SetException(Exception exception) { }
    public MyTask Task => default(MyTask);
    public void AwaitOnCompleted<TAwaiter, TStateMachine>(ref TAwaiter awaiter, ref TStateMachine stateMachine) where TAwaiter : INotifyCompletion where TStateMachine : IAsyncStateMachine { }
    public void AwaitUnsafeOnCompleted<TAwaiter, TStateMachine>(ref TAwaiter awaiter, ref TStateMachine stateMachine) where TAwaiter : ICriticalNotifyCompletion where TStateMachine : IAsyncStateMachine { }
}

更新：编译器文档中添加了 small spec for task-like types。

在 C#7 中，如何 "roll my own" 类任务类型与异步一起使用？

In C#7, how can I "roll my own" Task-like type to use with async?

c#

async-await

c#-7.0