2014-08-01 16:31:22 -07:00
|
|
|
% Rust Documentation
|
2013-12-22 20:21:45 -06:00
|
|
|
|
2015-12-23 14:15:13 -08:00
|
|
|
<style>
|
|
|
|
nav {
|
|
|
|
display: none;
|
|
|
|
}
|
|
|
|
</style>
|
2014-08-28 14:52:39 -04:00
|
|
|
|
2017-02-06 15:05:37 -05:00
|
|
|
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.
|
2014-08-28 14:52:39 -04:00
|
|
|
|
2017-03-13 19:13:26 -04:00
|
|
|
# API Documentation
|
2015-05-08 13:18:04 -07:00
|
|
|
|
2017-02-07 13:04:57 -05:00
|
|
|
Rust provides a standard library with a number of features; [we host its
|
|
|
|
documentation here][api].
|
2014-08-28 14:52:39 -04:00
|
|
|
|
2017-03-13 19:13:26 -04:00
|
|
|
# Extended Error Documentation
|
2016-01-10 22:30:09 +00:00
|
|
|
|
2017-02-07 13:04:57 -05:00
|
|
|
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][err], if you prefer to read them that way.
|
2017-02-06 15:05:37 -05:00
|
|
|
|
2017-03-13 19:13:26 -04:00
|
|
|
# The Rust Bookshelf
|
2017-02-06 15:05:37 -05:00
|
|
|
|
|
|
|
Rust provides a number of book-length sets of documentation, collectively
|
|
|
|
nicknamed 'The Rust Bookshelf.'
|
|
|
|
|
|
|
|
* [The Rust Programming Language][book] teaches you how to program in Rust.
|
2017-11-01 15:24:35 -04:00
|
|
|
* [The Cargo Book][cargo-book] is a guide to Cargo, Rust's build tool and dependency manager.
|
2017-02-28 14:09:27 -05:00
|
|
|
* [The Unstable Book][unstable-book] has documentation for unstable features.
|
2017-02-07 13:04:57 -05:00
|
|
|
* [The Rustonomicon][nomicon] is your guidebook to the dark arts of unsafe Rust.
|
2017-02-15 20:37:06 -05:00
|
|
|
* [The Reference][ref] is not a formal spec, but is more detailed and comprehensive than the book.
|
2017-08-14 13:58:21 -04:00
|
|
|
* [The Rustdoc Book][rustdoc-book] describes our documentation tool, `rustdoc`.
|
2017-02-15 20:37:06 -05:00
|
|
|
|
2017-04-25 05:35:51 -04:00
|
|
|
Initially, documentation lands in the Unstable Book, and then, as part of the
|
|
|
|
stabilization process, is moved into the Book, Nomicon, or Reference.
|
|
|
|
|
2017-02-15 20:37:06 -05:00
|
|
|
Another few words about the reference: it is guaranteed to be accurate, but not
|
2017-04-25 05:35:51 -04:00
|
|
|
complete. We have a policy that features must have documentation to be stabilized,
|
|
|
|
but we did not always have this policy, and so there are some stable things that
|
|
|
|
are not yet in the reference. We're working on back-filling things that landed
|
|
|
|
before this policy was put into place. That work is being tracked
|
|
|
|
[here][refchecklist].
|
2017-02-06 15:05:37 -05:00
|
|
|
|
|
|
|
[Rust Learning]: https://github.com/ctjhoa/rust-learning
|
|
|
|
[Docs.rs]: https://docs.rs/
|
2016-01-10 22:30:09 +00:00
|
|
|
[api]: std/index.html
|
2017-02-15 20:37:06 -05:00
|
|
|
[ref]: reference/index.html
|
2017-04-25 05:35:51 -04:00
|
|
|
[refchecklist]: https://github.com/rust-lang-nursery/reference/issues/9
|
2016-01-10 22:30:09 +00:00
|
|
|
[err]: error-index.html
|
2017-03-02 16:36:54 -05:00
|
|
|
[book]: book/index.html
|
2017-02-06 15:05:37 -05:00
|
|
|
[nomicon]: nomicon/index.html
|
2017-02-28 14:09:27 -05:00
|
|
|
[unstable-book]: unstable-book/index.html
|
2017-08-14 13:58:21 -04:00
|
|
|
[rustdoc-book]: rustdoc/index.html
|
2017-11-01 15:24:35 -04:00
|
|
|
[cargo-book]: cargo/index.html
|
2015-09-06 15:25:01 +03:00
|
|
|
|