<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <meta name="generator" content="rustdoc"> <title>Rust Documentation</title> <link rel="stylesheet" type="text/css" href="rust.css"> <link rel="shortcut icon" href="https://www.rust-lang.org/favicon.ico"> </head> <body class="rustdoc"> <!--[if lte IE 8]> <div class="warning"> This old browser is unsupported and will most likely display funky things. </div> <![endif]--> <div id="versioninfo"> <img src="https://www.rust-lang.org/logos/rust-logo-32x32-blk.png" width="32" height="32" alt="Rust logo"><br> <span class="white-sticker"><a href="https://www.rust-lang.org">Rust</a> 1.28.0</span><br> <a href="https://github.com/rust-lang/rust/commit/" class="hash white-sticker"></a> </div> <h1 class="title">Rust Documentation</h1> <nav id="TOC"><ul> <li><a href="#learn-rust">1 Learn Rust</a><ul> <li><a href="#the-rust-programming-language">1.1 The Rust Programming Language</a><ul></ul></li> <li><a href="#rust-by-example">1.2 Rust By Example</a><ul></ul></li></ul></li> <li><a href="#use-rust">2 Use Rust</a><ul> <li><a href="#the-standard-library">2.1 The Standard Library</a><ul></ul></li> <li><a href="#the-rustc-book">2.2 The Rustc Book</a><ul></ul></li> <li><a href="#the-cargo-book">2.3 The Cargo Book</a><ul></ul></li> <li><a href="#the-rustdoc-book">2.4 The Rustdoc Book</a><ul></ul></li> <li><a href="#extended-error-listing">2.5 Extended Error Listing</a><ul></ul></li></ul></li> <li><a href="#master-rust">3 Master Rust</a><ul> <li><a href="#the-reference">3.1 The Reference</a><ul></ul></li> <li><a href="#the-rustonomicon">3.2 The Rustonomicon</a><ul></ul></li> <li><a href="#the-unstable-book">3.3 The Unstable Book</a><ul></ul></li></ul></li></ul></nav><style> nav { display: none; } </style> <p>Welcome to an overview of the documentation provided by the Rust project. All of these projects are managed by the Docs Team; there are other unofficial documentation resources as well!</p> <p>Many of these resources take the form of "books"; we collectively call these "The Rust Bookshelf." Some are large, some are small.</p> <h1 id="learn-rust" class="section-header"><a href="#learn-rust">1 Learn Rust</a></h1> <p>If you'd like to learn Rust, this is the spot for you! All of these resources assume that you have programmed before, but not in any specific language:</p> <h2 id="the-rust-programming-language" class="section-header"><a href="#the-rust-programming-language">1.1 The Rust Programming Language</a></h2> <p>Affectionately nicknamed "the book," <a href="book/index.html">The Rust Programming Language</a> will give you an overview of the language from first principles. You'll build a few projects along the way, and by the end, you'll have a solid grasp of the language.</p> <h2 id="rust-by-example" class="section-header"><a href="#rust-by-example">1.2 Rust By Example</a></h2> <p>If reading multiple hundreds of pages about a language isn't your style, then <a href="rust-by-example/index.html">Rust By Example</a> has you covered. While the book talks about code with a lot of words, RBE shows off a bunch of code, and keeps the talking to a minimum. It also includes exercises!</p> <h1 id="use-rust" class="section-header"><a href="#use-rust">2 Use Rust</a></h1> <p>Once you've gotten familliar with the language, these resources can help you when you're actually using it day-to-day.</p> <h2 id="the-standard-library" class="section-header"><a href="#the-standard-library">2.1 The Standard Library</a></h2> <p>Rust's standard library has <a href="std/index.html">extensive API documentation</a>, with explanations of how to use various things, as well as example code for accomplishing various tasks.</p> <h2 id="the-rustc-book" class="section-header"><a href="#the-rustc-book">2.2 The Rustc Book</a></h2> <p><a href="rustc/index.html">The Rustc Book</a> describes the Rust compiler, <code>rustc</code>.</p> <h2 id="the-cargo-book" class="section-header"><a href="#the-cargo-book">2.3 The Cargo Book</a></h2> <p><a href="cargo/index.html">The Cargo Book</a> is a guide to Cargo, Rust's build tool and dependency manager.</p> <h2 id="the-rustdoc-book" class="section-header"><a href="#the-rustdoc-book">2.4 The Rustdoc Book</a></h2> <p><a href="rustdoc/index.html">The Rustdoc Book</a> describes our documentation tool, <code>rustdoc</code>.</p> <h2 id="extended-error-listing" class="section-header"><a href="#extended-error-listing">2.5 Extended Error Listing</a></h2> <p>Many of Rust's errors come with error codes, and you can request extended diagnostics from the compiler on those errors. You can also <a href="error-index.html">read them here</a>, if you prefer to read them that way.</p> <h1 id="master-rust" class="section-header"><a href="#master-rust">3 Master Rust</a></h1> <p>Once you're quite familiar with the language, you may find these advanced resources useful.</p> <h2 id="the-reference" class="section-header"><a href="#the-reference">3.1 The Reference</a></h2> <p><a href="reference/index.html">The Reference</a> is not a formal spec, but is more detailed and comprehensive than the book.</p> <h2 id="the-rustonomicon" class="section-header"><a href="#the-rustonomicon">3.2 The Rustonomicon</a></h2> <p><a href="nomicon/index.html">The Rustonomicon</a> is your guidebook to the dark arts of unsafe Rust. It's also sometimes called "the 'nomicon."</p> <h2 id="the-unstable-book" class="section-header"><a href="#the-unstable-book">3.3 The Unstable Book</a></h2> <p><a href="unstable-book/index.html">The Unstable Book</a> has documentation for unstable features.</p> <footer><p> Copyright © 2011 The Rust Project Developers. Licensed under the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a> or the <a href="https://opensource.org/licenses/MIT">MIT license</a>, at your option. </p><p> This file may not be copied, modified, or distributed except according to those terms. </p></footer> </body> </html>