Await 表达式

语法

AwaitExpression :

   表达式 . await

await 表达式是一种语法结构,用于暂停由 std::future::IntoFuture 的实现提供的计算,直到给定的 future 准备好生成值。 await 表达式的语法是一个表达式,其类型实现了 IntoFuture 特征,称为“future 操作数”,然后是 . 符号,最后是 await 关键字。 await 表达式只能在 异步上下文 中使用,例如 async fnasync

更具体地说,await 表达式具有以下效果。

  1. 通过在 future 操作数上调用 IntoFuture::into_future 来创建一个 future。
  2. 将 future 计算为一个 future tmp
  3. 使用 Pin::new_unchecked 固定 tmp
  4. 然后通过调用 Future::poll 方法并传递当前的 任务上下文 来轮询这个固定的 future;
  5. 如果对 poll 的调用返回 Poll::Pending,则 future 返回 Poll::Pending,暂停其状态,以便在重新轮询周围的异步上下文时,执行从步骤 3 恢复;
  6. 否则,对 poll 的调用必须返回 Poll::Ready,在这种情况下,Poll::Ready 变体中包含的值将用作 await 表达式本身的结果。

版本差异:Await 表达式仅从 Rust 2018 开始可用。

任务上下文

任务上下文指的是在轮询当前 异步上下文 时提供给它的 Context。因为 await 表达式只能在异步上下文中使用,所以必须有一些可用的任务上下文。

近似解糖

实际上,await 表达式大致相当于以下非规范解糖

match operand.into_future() {
    mut pinned => loop {
        let mut pin = unsafe { Pin::new_unchecked(&mut pinned) };
        match Pin::future::poll(Pin::borrow(&mut pin), &mut current_context) {
            Poll::Ready(r) => break r,
            Poll::Pending => yield Poll::Pending,
        }
    }
}

其中 yield 伪代码返回 Poll::Pending,并在重新调用时从该点恢复执行。变量 current_context 指的是从异步环境中获取的上下文。