How can I download Rust API docs?

by

Rustup

If you use rustup, the recommended way to install and update Rust, then the docs may already be installed; the default installation behavior has changed over time. Try running rustup doc to open them in your browser.

If they aren’t already installed, you can download the docs by running rustup component add rust-docs.

By default, rustup doc opens the documentation front page, but you can add --std to jump straight to the standard API docs or --book for The Rust Programming Language. You can also use rustup doc std::iter::Iterator to open the documentation of a specific item.

rustup 1.20 learned the concept of profiles. These allow you to default to having docs installed for a toolchain (via the default profile) or not (via the minimal profile).

Standalone Rust Installer

The Rust installer also installs the documentation for the language and for Cargo. On Linux systems, it can be found at /usr/local/share/doc/{rust,cargo}.

More Related Contents:

  1. Why is it legal to borrow a temporary?
  2. Package with both a library and a binary?
  3. How can I create my own data structure with an iterator that returns mutable references?
  4. Do mutable references have move semantics?
  5. How do I match enum values with an integer?
  6. How to transform fields during serialization using Serde?
  7. Why is the mutable reference not moved here?
  8. “borrowed value does not live long enough” when using the builder pattern
  9. How do I use static lifetimes with threads?
  10. Is it possible to conditionally enable an attribute like `derive`?
  11. How can I create a function with a variable number of arguments?
  12. Thread ” has overflowed its stack when allocating a large array using Box
  13. Why is the bound `T: ‘a` required in order to store a reference `&’a T`?
  14. Type mismatches resolving a closure that takes arguments by reference
  15. How do you enable a Rust “crate feature”?
  16. How to implement Iterator yielding mutable references [duplicate]
  17. How can a Rust program access metadata from its Cargo package?
  18. How can the ref keyword be avoided when pattern matching in a function taking &self or &mut self?
  19. How do I disambiguate traits in Rust?
  20. How to swap two variables?
  21. Expected bound lifetime parameter, found concrete lifetime [E0271]
  22. How do I change a function’s qualifiers via conditional compilation?
  23. How to idiomatically alias a crate in Rust 2018?
  24. Cannot borrow immutable borrowed content as mutable
  25. Why do I get “does not live long enough” in a return value?
  26. Why does the compiler not complain that an iterator moved to a for loop is immutable?
  27. Removing items from a BTreeMap or BTreeSet found through iteration
  28. Why doesn’t the lifetime of a mutable borrow end when the function call is complete?
  29. How to tell what “features” are available per crate?
  30. Is there a way to get the field names of a struct in a macro?

Leave a Comment