Search std and external crate docs
We support search documentation of official crates (including std, proc_macro, test) and any external crates on docs.rs.
We'll sync the latest std search index automatically every day to ensure the docs freshness. There is no extension updating required to get the latest search index since v1.0.
Search Primitive Types and Modules
Search Structs, Traits and Enums
Search Functions, Methods and Macros
Search nightly docs
You can prefix / before the keyword to search nightly docs.
We'll sync the latest nightly search index automatically every day to ensure the docs freshness. There is no extension updating required to get the latest search index since v1.0.
Search with type mode
You can prefix a type to get the exclusive search result. Those type keywords including:
fn:asref to search function or
trait:iterator to search trait.
Offline mode, search local Rust docs
You can run command
rustup doc --std to open the offline std docs.
To enable the offline mode, you should check the checkbox and input the offline docs path on the popup page.
However, please check the Caveats if you are a Firefox user.
Search external crate docs
After you add the crate to extension, you can prefix @crate-name to search the docs
exclusive to that crate. For example, input
@tokio spawn to search docs of tokio.
~ is another pretty prefix to search the external crate docs. Unlike the @ prefix, ~ gives you the power to search docs across all your favorite crates effortlessly.
For example, input
~spawn, you can get results related to "spawn" from all your favorite crates
(e.g. tokio, async_std, smol, and futures ).
Search builtin attributes
Search builtin attributes (such as
non_exhaustive) are also supported,
by default, the result is mixed with other related docs or crates though.
If you prefer to search attribute exclusively, prefix a # (pound sign) before the keyword to narrow the result.
Search top 20K crates
We build top 20K crates index (near 50K in total on crates.io) once a day to help you search crates instantly. You can prefix an ! (exclamation mark) before the keyword to search docs.rs exclusively, prefix one more ! (double exclamation mark) to open crates.io page, prefix !!! (triple exclamation mark) to open crate's repository (See Open repository quickly).
Search compiler error code
Search Rust official book chapters
You can search all of Rust book chapters too! The result will show the title of the related page, parent chapter, and grandparent chapter. Don't forget the % is the prefix to perform the book searching.
Search Cargo Clippy lints
> (right angle bracket) is also a great prefix to help you search Cargo Clippy lints exclusively.
Search Caniuse.rs and RFC
You can search caniuse.rs and RFC with ? and ?? prefix respectively.
The command system brings a handy set of useful and convenient commands to you. Each command starts with a : (colon), followed by the name, and function differently in individual. Those commands including but not limited to:
- :help - Show the help messages.
- :cargo - Show all useful third-party cargo subcommands.
- :yet - Show all Are We Yet websites.
- :book - Show all Rust official books.
- :stable - Show stable Rust scheduled release date in the next year.
- :label - Show all issue labels of rust-lang repository.
- :tool - Show useful rust tools.
- :mirror - Show all Rust mirror websites.
- :stats - open search statistics page.
- :update - open the update page to sync the latest index automatically.
- :release - Open rust-lang repository release page.
- :history - Show your local search history.
Rust docs enhancement
Make all "since" and "issue" linkable
Two kinds of tags links to corresponding urls, including:
- "since" links to Github release page (works in docs page and source code page)
- "issue" links to Github issue (works in source code page)
Display Feature Flags
Docs.rs don't display the crate's feature flags, which is inconvenient. So Rust Search Extension fills the gap.
Add your favorite crate to extension
By clicking the
+ to Rust Search Extension button, you can add the crate to the extension, which brings the
search capability for this crate on the address bar.
Rust repository enhancement
Show table of content in the release page
Searching statistics page provides a set of useful charts to visualize your search history. This gives you a powerful insight view on how frequency you search, how much valuable time you saved.
These charts including:
- A calendar heatmap represents your searching history in the last year
- A percentage chart reflects each category weight you searched
- Weekly, daily, and hourly bar chart tells you searching frequency in different time dimensionality
- Top searched crates chart gives you the rank of personal crate searching
Customize crates searching platform
Open repository quickly
You can prefix !!! (triple !) to open crate's repository quickly.
For example, input
!!!tokio then enter, the extension will obtain the repository url then redirect to
the github repository page of tokio effortlessly.
Page down/up easily
You can press
space after the keyword, then increase or decrease the number of - (hyphen) to page down or page up.