1
1
% Rust Documentation
2
2
3
- Welcome to the Rust documentation! You can use the section headings above
4
- to jump to any particular section.
5
-
6
- # Getting Started
7
-
8
- If you haven't seen Rust at all yet, the first thing you should read is the [ 30
9
- minute intro] ( intro.html ) . It will give you an overview of the basic ideas of Rust
10
- at a high level.
11
-
12
- Once you know you really want to learn Rust, the next step is reading [ the
13
- guide] ( guide.html ) . It is a lengthy explanation of Rust, its syntax, and its
14
- concepts. Upon completing the guide, you'll be an intermediate Rust developer,
15
- and will have a good grasp of the fundamental ideas behind Rust.
16
-
17
- # Community & Getting Help
18
-
19
- If you need help with something, or just want to talk about Rust with others,
20
- there's a few places you can do that:
21
-
22
- The Rust IRC channels on [ irc.mozilla.org] ( http://irc.mozilla.org/ ) are the
23
- fastest way to get help.
24
- [ ` #rust ` ] ( http://chat.mibbit.com/?server=irc.mozilla.org&channel=%23rust ) is
25
- the general discussion channel, and you'll find people willing to help you with
26
- any questions you may have.
27
-
28
- There are also three specialty channels:
29
- [ ` #rust-gamedev ` ] ( http://chat.mibbit.com/?server=irc.mozilla.org&channel=%23rust-gamedev )
30
- and
31
- [ ` #rust-osdev ` ] ( http://chat.mibbit.com/?server=irc.mozilla.org&channel=%23rust-osdev )
32
- are for game development and operating system development, respectively.
33
- There's also
34
- [ ` #rust-internals ` ] ( http://chat.mibbit.com/?server=irc.mozilla.org&channel=%23rust-internals ) , which is for discussion of the development of Rust itself.
35
-
36
- You can also get help on [ Stack
37
- Overflow] ( http://stackoverflow.com/questions/tagged/rust ) . Searching for your
38
- problem might reveal someone who has asked it before!
39
-
40
- There is an active [ subreddit] ( http://reddit.com/r/rust ) with lots of
41
- discussion about Rust.
42
-
43
- There is also a [ developer forum] ( http://discuss.rust-lang.org/ ) , where the
44
- development of Rust itself is discussed.
3
+ <!-- Completely hide the TOC and the section numbers -->
4
+ <style type =" text/css " >
5
+ #TOC { display : none ; }
6
+ .header-section-number { display : none ; }
7
+ li {list-style-type : none ; }
8
+ </style >
45
9
10
+ * [ A 30-minute Intro to Rust] ( intro.html )
11
+ * [ The Rust tutorial] ( tutorial.html ) (* [ PDF] ( tutorial.pdf ) )
12
+ * [ The Rust reference manual] ( rust.html ) (* [ PDF] ( rust.pdf ) )
46
13
47
14
# Guides
48
15
49
- Rust Guides are in-depth looks at a particular topic that's relevant to Rust
50
- development. If you're trying to figure out how to do something, there may be
51
- a guide that can help you out:
52
-
53
16
* [ Strings] ( guide-strings.html )
54
17
* [ Pointers] ( guide-pointers.html )
55
18
* [ References and Lifetimes] ( guide-lifetimes.html )
@@ -61,43 +24,70 @@ a guide that can help you out:
61
24
* [ Testing] ( guide-testing.html )
62
25
* [ Rust's Runtime] ( guide-runtime.html )
63
26
64
- # Tools
65
-
66
- Rust's still a young language, so there isn't a ton of tooling yet, but the
67
- tools we have are really nice.
68
-
69
- [ Cargo] ( http://crates.io ) is Rust's package manager, and its website contains
70
- lots of good documentation.
71
-
72
- [ The ` rustdoc ` manual] ( rustdoc.html ) contains information about Rust's
73
- documentation tool.
74
-
75
27
# FAQs
76
28
77
- There are questions that are asked quite often, and so we've made FAQs for them:
78
-
79
29
* [ Language Design FAQ] ( complement-design-faq.html )
80
30
* [ Language FAQ] ( complement-lang-faq.html )
81
31
* [ Project FAQ] ( complement-project-faq.html )
82
32
* [ How to submit a bug report] ( complement-bugreport.html )
83
33
84
- # The standard library
85
-
86
- You can find function-level documentation for the entire standard library
87
- [ here] ( std/index.html ) . There's a list of crates on the left with more specific
88
- sections, or you can use the search bar at the top to search for something if
89
- you know its name.
34
+ # Libraries
35
+
36
+ * [ The standard library, ` std ` ] ( std/index.html )
37
+
38
+ <!-- force the two lists to be separate -->
39
+
40
+ * [ The ` arena ` allocation library] ( arena/index.html )
41
+ * [ The ` collections ` library] ( collections/index.html )
42
+ * [ The ` flate ` compression library] ( flate/index.html )
43
+ * [ The ` fourcc ` four-character code library] ( fourcc/index.html )
44
+ * [ The ` getopts ` argument parsing library] ( getopts/index.html )
45
+ * [ The ` glob ` file path matching library] ( glob/index.html )
46
+ * [ The ` green ` M: N runtime library] ( green/index.html )
47
+ * [ The ` hexfloat ` library for hexadecimal floating-point literals] ( hexfloat/index.html )
48
+ * [ The ` libc ` bindings] ( libc/index.html )
49
+ * [ The ` native ` 1:1 threading runtime] ( native/index.html )
50
+ * [ The ` num ` arbitrary precision numerics library] ( num/index.html )
51
+ * [ The ` rand ` library for random numbers and distributions] ( rand/index.html )
52
+ * [ The ` regex ` library for regular expressions] ( regex/index.html )
53
+ * [ The ` rustc ` compiler] ( rustc/index.html )
54
+ * [ The ` rustuv ` M: N I/O library] ( rustuv/index.html )
55
+ * [ The ` semver ` version collation library] ( semver/index.html )
56
+ * [ The ` serialize ` value encoding/decoding library] ( serialize/index.html )
57
+ * [ The ` sync ` library for concurrency-enabled mechanisms and primitives] ( sync/index.html )
58
+ * [ The ` syntax ` library, the Rust parser] ( syntax/index.html )
59
+ * [ The ` term ` terminal-handling library] ( term/index.html )
60
+ * [ The ` test ` library containing the unit-testing & micro-benchmark framework] ( test/index.html )
61
+ * [ The ` time ` library] ( time/index.html )
62
+ * [ The ` uuid ` 128-bit universally unique identifier library] ( uuid/index.html )
63
+ * [ The ` url ` library] ( url/index.html )
64
+ * [ The ` log ` library] ( log/index.html )
65
+
66
+ # Tooling
67
+
68
+ * [ The ` rustdoc ` manual] ( rustdoc.html )
90
69
91
70
# External documentation
92
71
93
- * Note: While these are great resources for learning Rust, they may track a
94
- particular version of Rust that is likely not exactly the same as that for
95
- which this documentation was generated.*
72
+ * Note: While these are great resources for learning Rust, they may
73
+ track a particular version of Rust that is likely not exactly the same
74
+ as that for which this documentation was generated.*
96
75
97
- * [ Rust by Example] - Short examples of common tasks in Rust (tracks the master
98
- branch).
99
- * [ Rust for Rubyists] - The first community tutorial for Rust. Tracks the last
100
- stable release. Not just for Ruby programmers.
76
+ * [ Rust for Rubyists] - An excellent introduction for Rust; not just for Rubyists (tracks the most recent release).
77
+ * [ Rust by Example] - Short examples of common tasks in Rust (tracks the master branch).
78
+ * [ The Rust wiki] ( http://github.com/rust-lang/rust/wiki )
101
79
102
- [ Rust by Example ] : http://rustbyexample.com/
103
80
[ Rust for Rubyists ] : http://www.rustforrubyists.com/
81
+ [ Rust by Example ] : http://rustbyexample.com/
82
+
83
+ # Community
84
+
85
+ * [ Reddit] ( http://reddit.com/r/rust )
86
+ * [ Stack Overflow] ( http://stackoverflow.com/questions/tagged/rust )
87
+ * [ Developer Forum] ( http://discuss.rust-lang.org/ )
88
+ * The Rust IRC channels on [ irc.mozilla.org] ( http://irc.mozilla.org/ ) :
89
+ * [ ` #rust ` ] ( http://chat.mibbit.com/?server=irc.mozilla.org&channel=%23rust ) - general discussion
90
+ * [ ` #rust-gamedev ` ] ( http://chat.mibbit.com/?server=irc.mozilla.org&channel=%23rust-gamedev ) - game development
91
+ * [ ` #rust-internals ` ] ( http://chat.mibbit.com/?server=irc.mozilla.org&channel=%23rust-internals ) - compiler and libraries
92
+ * [ ` #rust-osdev ` ] ( http://chat.mibbit.com/?server=irc.mozilla.org&channel=%23rust-osdev ) - operating system development
93
+
0 commit comments