1
0
mirror of https://github.com/google/comprehensive-rust.git synced 2025-01-10 00:44:21 +02:00
This is the Rust course used by the Android team at Google. It provides you the material to quickly teach Rust.
Go to file
Martin Geisler b7de49e1b8 Simplify state transitions for speaker notes
Before, we attempted to change state from “popup” to “inline-open”
when the speaker note window was closed.

We did this by listening to “pagehide” and change the state there. The
event fires every time you navigate away from the page, so we had a
complex setup where we would reset the state to “popup” when the next
page was loaded into the speaker note window.

The problem with this is that it’s racy: we could end up in a
situation where we set the state to “inline-open” right after the
speaker note window was updated. When that happened, we would mark the
window as “defunct”, meaning that it was supposed to be closed.

With this change, we no longer try to change the state from the
speaker note window. If the window is lost (closed), the user will
have to click the “Close speaker notes” button in the top-right to
reset the state. This should be much more reliable.

Long-term, a better solution would be to let the speaker notes fetch
the current URL using JavaScript instead of doing it via an actual
page navigation. That should allow us to react to “pagehide” events
again (since they won’t fire on every page transition).
2023-01-12 12:31:26 +01:00
.github/workflows Simplify the publish workflow 2023-01-03 15:49:21 +01:00
src Merge pull request #158 from brandonpollack23/stackheap 2023-01-12 11:53:54 +01:00
third_party Publish Comprehensive Rust 🦀 2022-12-21 16:38:28 +01:00
.gitignore Add Cargo.lock 2023-01-03 14:42:33 +01:00
book.toml Add support for speaker notes 2023-01-05 07:46:18 +01:00
Cargo.lock Bump tokio from 1.23.0 to 1.24.1 2023-01-06 22:02:55 +00:00
Cargo.toml Publish Comprehensive Rust 🦀 2022-12-21 16:38:28 +01:00
CONTRIBUTING.md Publish Comprehensive Rust 🦀 2022-12-21 16:38:28 +01:00
ga4.js Publish Comprehensive Rust 🦀 2022-12-21 16:38:28 +01:00
LICENSE.txt Publish Comprehensive Rust 🦀 2022-12-21 16:38:28 +01:00
README.md Explain how the course can be used 2023-01-03 16:55:33 +01:00
rustfmt.toml Publish Comprehensive Rust 🦀 2022-12-21 16:38:28 +01:00
speaker-notes.css Simplify state transitions for speaker notes 2023-01-12 12:31:26 +01:00
speaker-notes.js Simplify state transitions for speaker notes 2023-01-12 12:31:26 +01:00
svgbob.css Fix svgbob diagrams in dark mode 2022-12-27 17:04:14 +01:00

Comprehensive Rust 🦀

This repository has the source code for Comprehensive Rust 🦀, a four 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 Android-specific content on the last day.

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.

Building

The course is built using mdBook and its Svgbob plugin. Install both tools with

$ cargo install mdbook
$ cargo install mdbook-svgbob

Then 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.

Contact

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