1
+ <!DOCTYPE html>
2
+ < html lang ="en ">
3
+ < head >
4
+ < meta charset ="utf-8 ">
5
+ < meta name ="viewport " content ="width=device-width, initial-scale=1.0 ">
6
+ < meta name ="generator " content ="rustdoc ">
7
+ < title > Rust Documentation</ title >
8
+
9
+ < link rel ="stylesheet " type ="text/css " href ="rust.css ">
10
+
11
+ < link rel ="shortcut icon " href ="https://www.rust-lang.org/favicon.ico ">
12
+
13
+
14
+ </ head >
15
+ < body class ="rustdoc ">
16
+ <!--[if lte IE 8]>
17
+ <div class="warning">
18
+ This old browser is unsupported and will most likely display funky
19
+ things.
20
+ </div>
21
+ <![endif]-->
22
+
23
+ < div id ="versioninfo ">
24
+ < img src ="https://www.rust-lang.org/logos/rust-logo-32x32-blk.png " width ="32 " height ="32 " alt > < br >
25
+ < span class ="white-sticker "> < a href ="https://www.rust-lang.org "> Rust</ a > 1.9</ span > < br >
26
+ < a href ="https://github.com/rust-lang/rust/commit/ "
27
+ class ="hash white-sticker "> </ a >
28
+ </ div >
29
+
30
+
31
+ < h1 class ="title "> Rust Documentation</ h1 >
32
+ < nav id ="TOC "> < ul >
33
+ < li > < a href ="#getting-started "> 1 Getting Started</ a > < ul > </ ul > </ li >
34
+ < li > < a href ="#language-reference "> 2 Language Reference</ a > < ul > </ ul > </ li >
35
+ < li > < a href ="#standard-library-reference "> 3 Standard Library Reference</ a > < ul > </ ul > </ li >
36
+ < li > < a href ="#the-rustonomicon "> 4 The Rustonomicon</ a > < ul > </ ul > </ li >
37
+ < li > < a href ="#tools "> 5 Tools</ a > < ul > </ ul > </ li >
38
+ < li > < a href ="#faqs "> 6 FAQs</ a > < ul > </ ul > </ li >
39
+ < li > < a href ="#the-error-index "> 7 The Error Index</ a > < ul > </ ul > </ li >
40
+ < li > < a href ="#community-translations "> 8 Community Translations</ a > < ul > </ ul > </ li > </ ul > </ nav > < p > Welcome to the Rust documentation! You can use the section headings above
41
+ to jump to any particular section.</ p >
42
+
43
+ < h1 id ='getting-started ' class ='section-header '> < a href ='#getting-started '> 1 Getting Started</ a > </ h1 >
44
+ < p > If you haven't seen Rust at all yet, the first thing you should read is the
45
+ introduction to < a href ="book/index.html "> The Rust Programming Language</ a > . It'll give
46
+ you a good idea of what Rust is like.</ p >
47
+
48
+ < p > The book provides a lengthy explanation of Rust, its syntax, and its
49
+ concepts. Upon completing the book, you'll be an intermediate Rust
50
+ developer, and will have a good grasp of the fundamental ideas behind
51
+ Rust.</ p >
52
+
53
+ < p > < a href ="http://rustbyexample.com/ "> Rust By Example</ a > teaches you Rust through a series of small
54
+ examples.</ p >
55
+
56
+ < h1 id ='language-reference ' class ='section-header '> < a href ='#language-reference '> 2 Language Reference</ a > </ h1 >
57
+ < p > Rust does not have an exact specification yet, but an effort to describe as much of
58
+ the language in as much detail as possible is in < a href ="reference.html "> the reference</ a > .</ p >
59
+
60
+ < h1 id ='standard-library-reference ' class ='section-header '> < a href ='#standard-library-reference '> 3 Standard Library Reference</ a > </ h1 >
61
+ < p > We have < a href ="std/index.html "> API documentation for the entire standard
62
+ library</ a > . There's a list of crates on the left with more
63
+ specific sections, or you can use the search bar at the top to search for
64
+ something if you know its name.</ p >
65
+
66
+ < h1 id ='the-rustonomicon ' class ='section-header '> < a href ='#the-rustonomicon '> 4 The Rustonomicon</ a > </ h1 >
67
+ < p > < a href ="nomicon/index.html "> The Rustonomicon</ a > is an entire book dedicated to explaining
68
+ how to write < code > unsafe</ code > Rust code. It is for advanced Rust programmers.</ p >
69
+
70
+ < h1 id ='tools ' class ='section-header '> < a href ='#tools '> 5 Tools</ a > </ h1 >
71
+ < p > < a href ="http://doc.crates.io/index.html "> Cargo</ a > is the Rust package manager providing access to libraries
72
+ beyond the standard one, and its website contains lots of good documentation.</ p >
73
+
74
+ < p > < a href ="book/documentation.html "> < code > rustdoc</ code > </ a > is the Rust's documentation generator, a tool converting
75
+ annotated source code into HTML docs.</ p >
76
+
77
+ < h1 id ='faqs ' class ='section-header '> < a href ='#faqs '> 6 FAQs</ a > </ h1 >
78
+ < p > There are questions that are asked quite often, so we've made FAQs for them:</ p >
79
+
80
+ < ul >
81
+ < li > < a href ="complement-design-faq.html "> Language Design FAQ</ a > </ li >
82
+ < li > < a href ="complement-lang-faq.html "> Language FAQ</ a > </ li >
83
+ < li > < a href ="complement-project-faq.html "> Project FAQ</ a > </ li >
84
+ < li > < a href ="https://github.com/rust-lang/rust/blob/master/CONTRIBUTING.md#bug-reports "> How to submit a bug report</ a > </ li >
85
+ </ ul >
86
+
87
+ < h1 id ='the-error-index ' class ='section-header '> < a href ='#the-error-index '> 7 The Error Index</ a > </ h1 >
88
+ < p > If you encounter an error while compiling your code you may be able to look it
89
+ up in the < a href ="error-index.html "> Rust Compiler Error Index</ a > .</ p >
90
+
91
+ < h1 id ='community-translations ' class ='section-header '> < a href ='#community-translations '> 8 Community Translations</ a > </ h1 >
92
+ < p > Several projects have been started to translate the documentation into other
93
+ languages:</ p >
94
+
95
+ < ul >
96
+ < li > < a href ="https://github.com/kgv/rust_book_ru "> Russian</ a > </ li >
97
+ < li > < a href ="https://github.com/rust-kr/doc.rust-kr.org "> Korean</ a > </ li >
98
+ < li > < a href ="https://github.com/KaiserY/rust-book-chinese "> Chinese</ a > </ li >
99
+ < li > < a href ="https://goyox86.github.io/elpr "> Spanish</ a > </ li >
100
+ < li > < a href ="https://panicbit.github.io/rustbook-de "> German</ a > </ li >
101
+ </ ul >
102
+
103
+ < script type ="text/javascript ">
104
+ window . playgroundUrl = "https://play.rust-lang.org/" ;
105
+ </ script >
106
+ < footer > < p >
107
+ Copyright © 2011-2015 The Rust Project Developers. Licensed under the
108
+ < a href ="http://www.apache.org/licenses/LICENSE-2.0 "> Apache License, Version 2.0</ a >
109
+ or the < a href ="http://opensource.org/licenses/MIT "> MIT license</ a > , at your option.
110
+ </ p > < p >
111
+ This file may not be copied, modified, or distributed except according to those terms.
112
+ </ p > </ footer >
113
+ < script type ="text/javascript " src ="playpen.js "> </ script >
114
+
115
+
116
+ </ body >
117
+ </ html >
0 commit comments