src/doc/index.md

   1 % Rust documentation
   2
   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>
   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))
  13
  14 # Guides
  15
  16 * [Strings](guide-strings.html)
  17 * [Pointers](guide-pointers.html)
  18 * [References and Lifetimes](guide-lifetimes.html)
  19 * [Containers and Iterators](guide-container.html)
  20 * [Tasks and Communication](guide-tasks.html)
  21 * [Foreign Function Interface](guide-ffi.html)
  22 * [Writing Safe Unsafe and Low-Level Code](guide-unsafe.html)
  23 * [Macros](guide-macros.html)
  24 * [Testing](guide-testing.html)
  25 * [Rust's Runtime](guide-runtime.html)
  26
  27 # FAQs
  28
  29 * [Language Design FAQ](complement-design-faq.html)
  30 * [Language FAQ](complement-lang-faq.html)
  31 * [Project FAQ](complement-project-faq.html)
  32 * [How to submit a bug report](complement-bugreport.html)
  33
  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)
  69
  70 # External documentation
  71
  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.*
  75
  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)
  79
  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