rustdoc-json

一个用于编程方式处理 rustdoc JSON 的库。

构建 rustdoc JSON

要为具有清单路径 project/Cargo.toml 的库构建 rustdoc JSON，操作如下

let json_path = rustdoc_json::Builder::default()
    .toolchain("nightly")
    .manifest_path("project/Cargo.toml")
    .build()
    .unwrap();

// Prints `Wrote rustdoc JSON to "/Users/martin/src/project/target/doc/project.json"`
println!("Wrote rustdoc JSON to {:?}", &json_path);

还有许多其他的构建选项。请参阅 文档 了解所有选项。

变更日志

请参阅 CHANGELOG.md。

测试

该库通过 public-api 和 cargo-public-api 测试套件间接和大量地进行测试。它们的测试高度依赖于这个库，所以如果所有测试都通过，那么这个库应该按预期工作。当然，在发布新版本之前，所有测试都确保通过。