Question

我在我的库的文档示例中修复错误时遇到了困难。我的文件结构类似于我的包bignum

.
|-- Cargo.lock
|-- Cargo.toml
|-- examples
|   |-- dat
|   |   `-- euler_13.dat
|   |-- debug.rs
|   `-- euler_13.rs
|-- README.md
|-- src
|   |-- error.rs
|   |-- inits.rs
|   `-- lib.rs

在我的示例中，我的标题看起来像

// euler_13.rs 
extern crate bignum;
use bignum::inits::Zero;

// ...

这编译并且效果很好，但现在当我在lib.rs的文档中编写示例时，我似乎无法导入bignum::inits::Zero

//lib.rs
//...

impl BigNum {

    //...


    /// Constructs a ...
    ///
    /// # Examples
    ///
    /// ```
    /// extern crate bignum;
    /// use bignum::inits::Zero;
    ///
    /// let a = bignum::BigNum::new(Zero::zero());
    /// ```
    ///
    pub fn new(base: BigNum) -> BigNum {
        // ...
    }

当我运行cargo test时，我收到此错误

     Running target/debug/lib-fe3dd7a75a504b04

running 3 tests
test crate_from_u32 ... ok
test create_from_string ... ok
test adding_no_carry ... ok

test result: ok. 3 passed; 0 failed; 0 ignored; 0 measured

   Doc-tests bignum

running 1 test
test new_0 ... FAILED

failures:

---- new_0 stdout ----
    <anon>:3:9: 3:15 error: unresolved import `self::bignum::inits::Zero`. Did you mean `self::self::bignum::inits`?
<anon>:3     use self::bignum::inits::Zero;
                 ^~~~~~
error: aborting due to previous error
thread 'new_0' panicked at 'Box<Any>', /home/rustbuild/src/rust-buildbot/slave/stable-dist-rustc-linux/build/src/libsyntax/diagnostic.rs:192



failures:
    new_0

我见过this问题，但是这涉及从同一个文件中导入仍然需要扩展范围的模块。但是，我仍在使用bignum::指定顶级范围。

因此，虽然导入bignum::inits::Zero适用于我的所有测试和示例，但它对我的文档不起作用。这是为什么？我尝试在前面添加self::并收到相同的错误。如果我将doc示例更改为

extern crate bignum;

let a = bignum::BigNum::new(bignum::inits::Zero::zero());

然而，它编译得很好。如何正确导入模块？

Answer 1

我认为问题源于此useful feature of the doc tests：

rustdoc会自动在您的代码周围添加main()包装器，并且位于正确的位置。

如果您在链接中应用规则，则最终会编译如下代码：

fn main() {
   extern crate bignum;
   use bignum::inits::Zero;

   let a = bignum::BigNum::new(Zero::zero());
}

然后，您确实需要将其称为self::bignum，因为第一条错误消息表明了这一点。不幸的是，由于Rust issue 23314，目前无法使用。

Answer 2

因此产生此错误的原因可归结为文档示例隐式使用func randomize(){ ball.backgroundColor = randomColor() }，这意味着我不需要明确告诉我将使用{{1}的示例}。

这是有道理的，因为在文档级别，示例显示了您的包的特定部分的功能应该如何工作，因此您无论如何都将使用extern crate bignum。货物认识到这一点并为您输入bignum。应该的示例是：

bignum

文档示例中未解决的导入

2 个答案: