The Rust Programming Language

This repository contains the source of "The Rust Programming Language" book, specifically an experimental branch that supports interactive features like quizzes.

If you discovered an issue in at https://rust-book.cs.brown.edu/, PLEASE report the issue on THIS REPOSITORY and not elsewhere.

The book is available in dead-tree form from No Starch Press.

You can also read the book for free online. Please see the book as shipped with the latest stable, beta, or nightly Rust releases. Be aware that issues in those versions may have been fixed in this repository already, as those releases are updated less frequently.

See the releases to download just the code of all the code listings that appear in the book.

Requirements

Building the book requires mdBook, ideally the same version that rust-lang/rust uses in this file. To get it:

$ cargo install mdbook --locked --version <version_num>

This fork also requires a few mdBook preprocessors to support our experimental extensions. Follow the installation instructions at each link below.

• mdbook-aquascope: https://github.com/cognitive-engineering-lab/aquascope#installation
• mdbook-quiz: https://github.com/cognitive-engineering-lab/mdbook-quiz#installation

You should install the same version of each preprocessor used in CI.

Finally, you need pnpm.

The book also uses two mdbook plugins which are part of this repository. If you do not install them, you will see warnings when building and the output will not look right, but you will still be able to build the book. To use the plugins, you should run:

$ cargo install --locked --path packages/mdbook-trpl-listing
$ cargo install --locked --path packages/mdbook-trpl-note

Building

With cargo-make

If you have cargo-make installed, then run:

$ cargo make build

Without cargo-make

First, build the Javascript extensions.

$ cd js-extensions
$ pnpm init-repo
$ cd ..

Then to build the book, type:

$ mdbook build

Output

The output will be in the book subdirectory. To check it out, open it in your web browser.

Firefox:

$ firefox book/index.html                       # Linux
$ open -a "Firefox" book/index.html             # OS X
$ Start-Process "firefox.exe" .\book\index.html # Windows (PowerShell)
$ start firefox.exe .\book\index.html           # Windows (Cmd)

Chrome:

$ google-chrome book/index.html                 # Linux
$ open -a "Google Chrome" book/index.html       # OS X
$ Start-Process "chrome.exe" .\book\index.html  # Windows (PowerShell)
$ start chrome.exe .\book\index.html            # Windows (Cmd)

To run the tests:

$ cd packages/trpl
$ mdbook test --library-path packages/trpl/target/debug/deps

Contributing

We'd love your help! Please see CONTRIBUTING.md to learn about the kinds of contributions we're looking for.

Because the book is printed, and because we want to keep the online version of the book close to the print version when possible, it may take longer than you're used to for us to address your issue or pull request.

So far, we've been doing a larger revision to coincide with Rust Editions. Between those larger revisions, we will only be correcting errors. If your issue or pull request isn't strictly fixing an error, it might sit until the next time that we're working on a large revision: expect on the order of months or years. Thank you for your patience!

Translations

We'd love help translating the book! See the Translations label to join in efforts that are currently in progress. Open a new issue to start working on a new language! We're waiting on mdbook support for multiple languages before we merge any in, but feel free to start!

Spellchecking

To scan source files for spelling errors, you can use the spellcheck.sh script available in the ci directory. It needs a dictionary of valid words, which is provided in ci/dictionary.txt. If the script produces a false positive (say, you used the word BTreeMap which the script considers invalid), you need to add this word to ci/dictionary.txt (keep the sorted order for consistency).