1.8 KiB
% Rust Documentation
This page is an overview of the documentation included with your Rust install. Other unofficial documentation may exist elsewhere; for example, the Rust Learning project collects documentation from the community, and Docs.rs builds documentation for individual Rust packages.
API Documentation
Rust provides a standard library with a number of features; we host its documentation here.
Extended Error Documentation
Many of Rust's errors come with error codes, and you can request extended diagnostics from the compiler on those errors. We also have the text of those extended errors on the web, if you prefer to read them that way.
The Rust Bookshelf
Rust provides a number of book-length sets of documentation, collectively nicknamed 'The Rust Bookshelf.'
- The Rust Programming Language teaches you how to program in Rust.
- The Unstable Book has documentation for unstable features.
- The Rustonomicon is your guidebook to the dark arts of unsafe Rust.
- The Reference is not a formal spec, but is more detailed and comprehensive than the book.
Another few words about the reference: it is guaranteed to be accurate, but not complete. We now have a policy that all new features must be included in the reference before stabilization; however, we are still back-filling things that landed before then. That work is being tracked here.