Skip to content

Latest commit

 

History

History
49 lines (36 loc) · 1.62 KB

index.md

File metadata and controls

49 lines (36 loc) · 1.62 KB

% Rust Documentation

<style> nav { display: none; } </style>

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.

Reference Documentation

Rust does not yet have a formal specification, but we have a reference document . 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.

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.'