我正在编写一个 Rust 库,我想在我的文档中提供示例
- 编译作为运行的一部分
cargo test
- do not run.
这可能吗?
我正在编写一个数据库客户端库,这些示例使用了一个假设的、不存在的数据库服务器。因此,这些示例在运行时总是会失败,但示例在语法上有效非常重要。因此我提出了上述要求。
如果没有办法做我想做的事,那么如何选择不做cargo test
运行特定的文档测试?即,有cargo run
编译并运行一些文档测试但完全忽略其他一些测试?
这记录在rustdoc 书 https://doc.rust-lang.org/rustdoc/,具体来说关于属性的章节 https://doc.rust-lang.org/rustdoc/documentation-tests.html#attributes.
您的起始代码块分隔符应如下所示:
/// ```no_run
摘自书中:
/// ```no_run
/// loop {
/// println!("Hello, world");
/// }
/// ```
The no_run
属性将编译您的代码,但不会运行它。这是
对于诸如“以下是如何检索网页”之类的示例很重要,
您希望确保编译,但可能会在测试中运行
没有网络访问的环境。
要完全省略构建,请使用ignore
代替no_run
.
本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系:hwhale#tublm.com(使用前将#替换为@)