如何识别Rust文档中被遮蔽的crate？解决依赖crate不可见问题

嘿，咱们一步步来解决这个Cargo文档的命名冲突问题！你遇到的情况是你的项目名称和某个依赖Crate完全重名，导致Cargo生成文档时，自身项目的文档覆盖了依赖Crate的文档路径，所以你看不到它的文档，甚至可能没意识到有这个同名依赖存在。

第一步：确认是否存在同名依赖 #

先排查你的项目是否真的和某个依赖重名：

• 打开项目根目录的Cargo.toml，查看顶部的name字段，这是你的项目名称。
• 然后看[dependencies]、[dev-dependencies]等区块，找有没有和项目名称完全一致的依赖项。
• 也可以用命令行快速检查：运行 cargo tree --full-names，这个命令会显示所有依赖的完整名称和版本，你可以直接搜索你的项目名称，看是否有匹配的依赖。

第二步：解决方法 #

根据你的需求，有两种常用方案：

方案1：重命名自己的项目（最推荐） #

这是最彻底的解决方式，能避免后续出现更多命名冲突问题：

1. 修改Cargo.toml中的name字段，改成一个不重复的名称（比如在原名称后加后缀，或者换个相关的名字）。
2. 如果项目中有内部模块引用了原项目名（比如use my_project::...），记得同步修改这些引用。
3. 重新生成文档：运行 cargo doc --open，此时依赖的同名Crate文档就会正常显示在左侧导航栏的“Dependencies”分类下了。

方案2：保留项目名称，手动指定依赖文档路径 #

如果你不想修改项目名称，可以通过Cargo的文档生成参数，强制为依赖Crate指定文档位置：
假设你的项目和依赖都叫my_crate，依赖的版本是1.0.0，运行以下命令生成文档：

cargo doc --open --extern-html-root-url my_crate=https://docs.rs/my_crate/1.0.0

这个命令会告诉Cargo，当遇到名为my_crate的依赖时，将它的文档链接指向docs.rs上的对应版本文档，同时本地生成的文档中也会正确区分你的项目和依赖的入口。你只需要把命令里的依赖名和版本号替换成你实际的依赖信息即可。

另外，如果你希望本地生成依赖的文档而不是链接到外部地址，可以尝试使用--target-dir指定一个临时目录单独生成依赖的文档，不过这种方式比较繁琐，不如前两种方案高效。

额外提示 #

如果还是看不到依赖的文档，可以检查是否在Cargo.toml中给依赖加了default-features = false或者某些特性限制导致文档无法生成，或者运行cargo doc --all-features尝试生成所有特性下的文档，看看是否能显示出来。

内容的提问来源于stack exchange，提问作者Frank Schwidom