有没有类似perldoc、Python help的Rust命令行离线文档查询方法?
Rust 无浏览器快速查询离线文档方法
Rust生态完全支持全离线的命令行文档查询,不需要打开浏览器、也不需要联网,可完美替代Perl的perldoc、Python的help能力,操作方案如下:
前置配置
如果你是通过官方rustup工具安装的Rust工具链,首先安装离线文档组件(部分精简安装默认会跳过,已安装可忽略):
rustup component add rust-docs
不同场景的查询方式
- 官方原生支持编译错误码查询,无需安装任何第三方工具,直接在终端执行即可查看完整的错误原因、触发场景和修复示例:
示例:查询类型不匹配错误码E0308的详情:rustc --explain E0308 - 在终端查询标准库API、关键字、语法规则:推荐使用
rustman工具,它会直接调用官方离线文档内容渲染到终端输出,使用逻辑和perldoc高度一致
安装命令:
示例:查询向量长度方法cargo install rustmanlen的用法:
示例:查询rustman Vec::lenmatch关键字的语法规则:rustman match - 查询项目第三方依赖库的文档:安装
cargo-show-doc工具后,可直接在项目目录下查询所有已安装依赖的文档
安装命令:
示例:查询序列化库cargo install cargo-show-docserde的Serializetrait用法:cargo show-doc serde::Serialize - 若临时可接受本地浏览器打开(完全离线,无任何网络请求),也可直接用官方原生命令,无需安装第三方工具:
打开标准库总文档:rustup doc std
打开当前项目所有依赖的整合文档:cargo doc --open
内容的提问来源于stack exchange,提问作者Evan Carroll
相关产品推荐
相关产品推荐

