2014-08-01 18:31:22 -05:00
|
|
|
% Rust Documentation
|
2013-12-22 20:21:45 -06:00
|
|
|
|
2014-08-28 13:52:39 -05:00
|
|
|
Welcome to the Rust documentation! You can use the section headings above
|
|
|
|
to jump to any particular section.
|
|
|
|
|
|
|
|
# Getting Started
|
|
|
|
|
2015-05-08 15:18:04 -05:00
|
|
|
If you haven't seen Rust at all yet, the first thing you should read is the
|
|
|
|
introduction to [The Rust Programming Language](book/index.html). It'll give
|
|
|
|
you a good idea of what Rust is like.
|
|
|
|
|
|
|
|
The book provides a lengthy explanation of Rust, its syntax, and its
|
|
|
|
concepts. Upon completing the book, you'll be an intermediate Rust
|
|
|
|
developer, and will have a good grasp of the fundamental ideas behind
|
|
|
|
Rust.
|
2014-08-28 13:52:39 -05:00
|
|
|
|
2015-09-06 08:07:55 -05:00
|
|
|
# Language Reference
|
2015-09-06 07:25:01 -05:00
|
|
|
|
2015-09-06 08:07:55 -05:00
|
|
|
Rust does not have an exact specification yet, but an effort to describe as much of
|
2015-09-06 07:25:01 -05:00
|
|
|
the language in as much detail as possible is in [the reference](reference.html).
|
|
|
|
|
2015-09-06 08:07:55 -05:00
|
|
|
# Standard Library Reference
|
2015-06-20 21:09:56 -05:00
|
|
|
|
|
|
|
We have [API documentation for the entire standard
|
|
|
|
library](std/index.html). There's a list of crates on the left with more
|
|
|
|
specific sections, or you can use the search bar at the top to search for
|
|
|
|
something if you know its name.
|
|
|
|
|
2015-11-03 14:52:18 -06:00
|
|
|
# The Rustonomicon
|
|
|
|
|
2015-11-16 13:48:18 -06:00
|
|
|
[The Rustonomicon] is an entire book dedicated to explaining
|
2015-11-03 14:52:18 -06:00
|
|
|
how to write `unsafe` Rust code. It is for advanced Rust programmers.
|
|
|
|
|
|
|
|
[The Rustonomicon]: nomicon/index.html
|
|
|
|
|
2015-05-12 06:21:26 -05:00
|
|
|
# The Error Index
|
|
|
|
|
|
|
|
If you encounter an error while compiling your code you may be able to look it
|
|
|
|
up in the [Rust Compiler Error Index](error-index.html).
|