16 releases (7 breaking)

0.7.1 Jul 5, 2022
0.6.1 Jun 24, 2022
0.3.1 Nov 3, 2021
0.2.0 Jul 5, 2021
0.0.1 Mar 31, 2021

#1104 in Development tools

MIT license

34KB
890 lines

rustdoc-index

crates.io docs.rs

A tool to quickly find the relevant item from rustdoc.

Installation

$ cargo install rustdoc-index $ rustup component add rust-docs

It requires Rust 1.53 that is now avaible on stable.

Usage

$ cargo listdoc
std::prelude	mod
std::prelude::v1	mod
std::prelude::rust_2015	mod
std::prelude::rust_2018	mod
std::prelude::rust_2021	mod
std::f32	mod
std::f32::consts	mod
std::f32::consts::PI	constant
std::f32::consts::TAU	constant
std::f32::consts::FRAC_PI_2	constant
...
$ cargo listdoc location "std::f32::consts::PI	constant"
file:///home/octaltree/.rustup/toolchains/nightly-x86_64-unknown-linux-gnu/share/doc/rust/html/std/f32/consts/constant.PI.html

With junegunn/fzf

cargo listdoc | fzf --bind 'ctrl-i:execute(cargo listdoc location {}| xargs firefox)'

Vim integration

denite source is available.

Installation

This is how to install using dein.

[[plugins]]
repo = 'octaltree/rustdoc-index'
build = 'make denite'

Usage

:Denite rustdoc-index

This is highly inspired by rhysd/rust-doc.vim. If you need the unite interface, please use that one.

Dependencies

~5–7MB
~125K SLoC