This is the Rust course used by the Android team at Google. It provides you the material to quickly teach Rust.
Go to file
Gergely Risko 889a4cbbee
Fix the debug exercise in the "Borrowing a Value" section (#2083)
Trying to reproduce this RVO shows that actually the optimization that
is used here is simple inlining. Once inlining is disabled, the
addresses change, even with `-O -C opt-level=3`.

The return of the values is also never changed to an "efficient memcpy",
but instead was returned on eax+edx, although this result is of course
specific to the calling convention of the platform ABI, but no memcpy on
the most popular amd64 architecture.

I don't think it's educationally important to teach RVO here, so I
didn't go into any length trying to force Rust to do a real RVO (passing
Point address into the function on the assembly level, so the function
can fill in the addition). In my opinion the only important thing is,
that if a student is actually clicking the Playground link and looks
into the assembly, then our description should match the generated code.
That's why I just fixed the content instead of trying to fix the example
to be RVO.
2024-05-17 10:07:47 -04:00
.github Retire @suetfei as zh-CN reviewer (#2059) 2024-05-06 09:13:30 -07:00
mdbook-course cargo: bump the patch group with 7 updates (#2077) 2024-05-13 10:28:26 +01:00
mdbook-exerciser cargo: bump the patch group with 7 updates (#2077) 2024-05-13 10:28:26 +01:00
po ru: Translate tuples-and-arrays segment and more (#2081) 2024-05-17 11:29:45 +01:00
src Fix the debug exercise in the "Borrowing a Value" section (#2083) 2024-05-17 10:07:47 -04:00
theme Saving playground code state (#1917) 2024-03-22 12:15:54 -04:00
third_party cargo: bump the minor group with 2 updates (#1783) 2024-02-05 11:25:39 +00:00
.gitignore Adding crowdin.yml to .gitignore (#2079) 2024-05-14 18:43:04 +00:00
CONTRIBUTING.md Update Windows Gettext installation instructions (#1447) 2023-11-06 13:05:13 -08:00
Cargo.lock cargo: bump the patch group with 7 updates (#2077) 2024-05-13 10:28:26 +01:00
Cargo.toml Update Concurrency course with times (#2007) 2024-04-23 13:26:41 +00:00
LICENSE Rename LICENSE.txt to LICENSE (#293) 2023-01-29 14:20:55 +01:00
README.md Revert "Update README.md with mdbook-pandoc install" (#1998) 2024-04-16 13:26:47 -07:00
STYLE.md Add a dev theme to help with slide aspect ratio (#1842) 2024-03-05 10:33:42 +00:00
TRANSLATIONS.md Tell translators to remove line numbers from PO files (#1753) 2024-01-25 09:46:24 +01:00
book.toml Updated struct and enums in pattern-matching. (#2021) 2024-04-30 10:07:10 -04:00
dprint.json Always use a nightly `rustfmt` in `dprint fmt` (#1694) 2024-01-16 19:10:02 +01:00
rustfmt.toml Format all Markdown files with `dprint` (#1157) 2023-12-31 00:15:07 +01:00

README.md

Comprehensive Rust 🦀

Build workflow GitHub contributors GitHub stars

This repository has the source code for Comprehensive Rust 🦀, a multi-day Rust course developed by the Android team. The course covers all aspects of Rust, from basic syntax to generics and error handling. It also includes deep dives on Android, Chromium, bare-metal, and concurrency.

Read the course at https://google.github.io/comprehensive-rust/.

Course Format and Target Audience

The course is used internally at Google when teaching Rust to experienced software engineers. They typically have a background in C++ or Java.

The course is taught in a classroom setting and we hope it will be useful for others who want to teach Rust to their team. The course will be less useful for self-study since you miss out on the discussions happening in the classroom. You don't see the questions and answers and you don't see the compiler errors we trigger when going through the code samples. We hope to improve on this via speaker notes and by publishing videos.

Press

Articles and blog posts from around the web which cover Comprehensive Rust:

Building

The course is built using a few tools:

First install Rust by following the instructions on https://rustup.rs/. Then clone this repository:

git clone https://github.com/google/comprehensive-rust/
cd comprehensive-rust

Then install these tools with:

cargo install mdbook
cargo install --locked mdbook-svgbob
cargo install --locked mdbook-i18n-helpers
cargo install --locked --path mdbook-exerciser
cargo install --locked --path mdbook-course

Run

mdbook test

to test all included Rust snippets. Run

mdbook serve

to start a web server with the course. You'll find the content on http://localhost:3000. You can use mdbook build to create a static version of the course in the book/ directory. Note that you have to separately build and zip exercises and add them to book/html. To build any of the translated versions of the course, run MDBOOK_BOOK__LANGUAGE=xx mdbook build -d book/xx where xx is the ISO 639 language code (e.g. da for the Danish translation). TRANSLATIONS.md contains further instructions.

Note On Windows, you need to enable symlinks (git config --global core.symlinks true) and Developer Mode.

Contact

For questions or comments, please contact Martin Geisler or start a discussion on GitHub. We would love to hear from you.