带有异步函数#[tokio-test]的Rust doc测试

Question

现在，我必须编写一个异步main函数，用#[tokio-main]标记它，并在其中调用test_fn().await，以便在货物测试--doc期间运行一些异步函数。

是否有其他更好的方法允许doc测试像正常测试函数一样运行，例如#[tokio-test]？另外，如果标记#[tokio-test]可以显示在文档中，那么用户就可以复制文档并直接将其用作项目中的测试。（这可能可以像##[tokio-test]那样实现？）

Answer 1

Doc测试自动将代码块包装在同步的fn main(){…}中。.awaiting需要异步运行库。您不能.await而不产生某种运行时。您可以为每个doc测试生成一个常规的多线程运行时：

/// ```rust
/// #[tokio::main]
/// async fn main() {
///    let len = async { "aaaa".len() }.await;
///    assert_eq!(len, 4);
/// }
/// ```

为每个doc测试生成一个运行时可能不是最好的主意。更好的方法是使用tokio_test::block_on，它使用测试本地运行时（类似于#[tokio-test])阻止提供的未来：

/// ```rust
/// let len = tokio_test::block_on( async { "aaaa".len() } );
/// assert_eq!(len, 4);
/// ```

为了减少样板，您可以为block_on创建一个宏：

macro_rules! bo {
  ($e:expr) => {
    tokio_test::block_on($e)
  };
}

/// ```rust
/// let len = async { "aaaa".len() };
/// assert_eq!(bo!(len), 4)
/// ```