如何阅读 rustdoc 的输出

Rustdoc 的 HTML 文件包含了有用的跳转入口，便于用户跳转理解你的代码。本章会覆盖入口的主要特性，同时也是良好的文档作者和用户的开端。

结构

rustdoc 的输出包含三部分，左侧是整个页面的快速导航，展示了当前条目的上下文信息。页面的右侧大版面由顶部的搜索和下面的文档页面主体组成。

屏幕的主要区域展示的是 item 的文档。

顶端是一览信息：

item 的类型和名称，比如 "Struct std::time::Duration"；
复制 crate 路径的按钮；
展开和收起 item 顶层文档的按钮 ([+] or [-])；
如果 configured, 并且可以展示（如果文档创建通过 cargo doc --no-deps 源码可能是无效的），会有源码的连接 ([src])；
如果 item 是标准库，会展示 item 稳定的版本。

下面是 item 的主要文档，包括函数签名，Rust 类型的 fields 列表或者 variants。最后页面列出关联的函数以及 trait 实现，包括 rustdoc 知道的自动和空白实现。

比如，当查看 crate 根文档的时候，会展示所有的 crate 文档的 modules，structs，traits，functions，macros 的快速链接。顶部，在当前 crate 名称和版本旁边或者当前 item 旁边展示 configurable logo。

当在支持 JavaScript 的浏览器中打开 rustdoc 的输出时，页面顶部会出现一个接口，左侧是主题选择（一个画笔图标），搜索栏，帮助提示和配置按钮。【译者注：主题选择已经在配置设置中】

点击主题选择会列出可选主题，默认是 ayu, light, and dark。

在搜索栏输入内容，会模糊匹配搜索当前的文档

默认搜索结果显示按照名称的结果，意味着模糊匹配 item 的名称，匹配的名称显示在左侧，如果有描述会显示在右侧，点击 item，你会跳转到对应的页面

还有两种结果，按照参数搜索，展示函数参数中类型的匹配结果，按返回值搜索，展示函数返回值类型的搜索结构。这两种搜索结果在你不知道函数名称，但是知道你想要的类型时非常有用。

当在搜索栏输入时，可以通过冒号前缀来限制搜索结果的类型（比如 mod:）

按下 S 焦点会移动到搜索框，按下 ? 会展示帮助界面，其中包括所有快捷键以及说明。按下 T 焦点移动到主题选择。【译者注：主题选择通过搜索栏的右侧 setting 按钮唤出】

当焦点在搜索结果时，左右箭头可以切换搜索的 tab，上下箭头可以移动关注的搜索结果。按下回车键可以打开高亮的结果。

当焦点在 item 文档时，加号和减号可以展开收起文档的小结。