9 This page is an overview of the documentation included with your Rust install.
10 Other unofficial documentation may exist elsewhere; for example, the [Rust
11 Learning] project collects documentation from the community, and [Docs.rs]
12 builds documentation for individual Rust packages.
16 Rust provides a standard library with a number of features; [we host its
17 documentation here][api].
19 # Extended Error Documentation
21 Many of Rust's errors come with error codes, and you can request extended
22 diagnostics from the compiler on those errors. We also [have the text of those
23 extended errors on the web][err], if you prefer to read them that way.
27 Rust provides a number of book-length sets of documentation, collectively
28 nicknamed 'The Rust Bookshelf.'
30 * [The Rust Programming Language][book] teaches you how to program in Rust.
31 * [The Unstable Book][unstable-book] has documentation for unstable features.
32 * [The Rustonomicon][nomicon] is your guidebook to the dark arts of unsafe Rust.
33 * [The Reference][ref] is not a formal spec, but is more detailed and comprehensive than the book.
35 Another few words about the reference: it is guaranteed to be accurate, but not
36 complete. We now have a policy that all new features must be included in the
37 reference before stabilization; however, we are still back-filling things that
38 landed before then. That work is being tracked [here][38643].
40 [Rust Learning]: https://github.com/ctjhoa/rust-learning
41 [Docs.rs]: https://docs.rs/
43 [ref]: reference/index.html
44 [38643]: https://github.com/rust-lang/rust/issues/38643
45 [err]: error-index.html
46 [book]: book/index.html
47 [nomicon]: nomicon/index.html
48 [unstable-book]: unstable-book/index.html