rust - 如何选择退出运行文档测试？

Question

我正在编写一个 Rust 库，我想在我的文档中提供示例

1. 编译作为运行cargo test的一部分
2. 不要运行。

这可能吗？

我正在编写一个数据库客户端库，示例使用了一个假设的、不存在的数据库服务器。因此，这些示例在运行时总是失败，但重要的是这些示例在语法上是有效的。因此我提出了上述要求。

如果没有办法做我想做的事，那么如何选择不让 cargo test 运行特定的文档测试？即，让 cargo run 编译并运行一些文档测试，但完全忽略其他一些测试？

Answer 1

这记录在 The rustdoc book 中，特别是 chapter about attributes .

您的起始代码块定界符应如下所示:

/// ```no_run

摘自本书:

/// ```no_run
/// loop {
///     println!("Hello, world");
/// }
/// ```

The no_run attribute will compile your code, but not run it. This is important for examples such as "Here's how to retrieve a web page," which you would want to ensure compiles, but might be run in a test environment that has no network access.

要完全省略构建，请使用 ignore 而不是 no_run。