Update to main and add async chapter

.github/workflows/main.yml

@@ -34,8 +34,8 @@ jobs:
     - name: Install Rust
       run: |
         rustup set profile minimal
-        rustup toolchain install 1.79 -c rust-docs
-        rustup default 1.79
+        rustup toolchain install 1.81 -c rust-docs
+        rustup default 1.81
 
     - name: Install Depot
       run: curl https://raw.githubusercontent.com/cognitive-engineering-lab/depot/main/scripts/install.sh | sh
@@ -112,9 +112,20 @@ jobs:
     #       https://raw.githubusercontent.com/rust-lang/rust/master/src/tools/linkchecker/linkcheck.sh
     #     # Cannot use --all here because of the generated redirect pages aren't available.
     #     sh linkcheck.sh book
-
+
+    # mdBook does not currently have particularly good support for “external”
+    # crates. To make the test suite work correctly with `trpl`, we must first
+    # build `trpl` itself (`mdbook` will not do it), and then explicitly pass
+    # its `deps` path as a library search path for `mdbook test`. That will make
+    # sure all the crates can be resolved when running the tests.
+    - name: Build `trpl` crate
+      run: |
+        cd packages/trpl
+        cargo build
+
     - name: Run mdbook tests
-      run: mdbook test
+      run:
+        mdbook test --library-path packages/trpl/target/debug/deps
 
     - name: Build mdbook
       run: mdbook build

2018-edition/src/ch17-03-oo-design-patterns.md

@@ -3,8 +3,8 @@
 The 2018 edition of the book is no longer distributed with Rust's documentation.
 
 If you came here via a link or web search, you may want to check out [the current
-version of the book](../ch17-03-oo-design-patterns.html) instead.
+version of the book](../ch18-03-oo-design-patterns.html) instead.
 
 If you have an internet connection, you can [find a copy distributed with
 Rust
-1.30](https://doc.rust-lang.org/1.30.0/book/2018-edition/ch17-03-oo-design-patterns.html).
+1.30](https://doc.rust-lang.org/1.30.0/book/2018-edition/ch17-03-oo-design-patterns.html).

ADMIN_TASKS.md

@@ -133,3 +133,13 @@ $ dot dot/trpl04-01.dot -Tsvg > src/img/trpl04-01.svg
 In the generated SVG, remove the width and the height attributes from the `svg`
 element and set the `viewBox` attribute to `0.00 0.00 1000.00 1000.00` or other
 values that don't cut off the image.
+
+## Publish a preview to GitHub Pages
+
+We sometimes publish to GitHub Pages for in-progress previews. The recommended
+flow for publishing is:
+
+- Install the `ghp-import` tool by running `pip install ghp-import` (or `pipx install ghp-import`, using [pipx][pipx]).
+- In the root, run `tools/generate-preview.sh`
+
+[pipx]: https://pipx.pypa.io/stable/#install-pipx

Cargo.toml

@@ -6,6 +6,7 @@ exclude = [
     "linkchecker", # linkchecker is part of the CI workflow
     "listings",    # these are intentionally distinct from the workspace
     "tmp",         # listings are built here when updating output via tools/update-rustc.sh
+    "packages/trpl",        # manages its own dependencies as a standalone crate
 
     # These are used as path dependencies in `rust-lang/rust` (since we are not
     # publishing them to crates.io), so they cannot be part of this workspace,

README.md

@@ -44,6 +44,16 @@ You should install the same version of each preprocessor [used in CI](https://gi
 
 Finally, you need [pnpm](https://pnpm.io/installation).
 
+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:
+
+```bash
+$ cargo install --locked --path packages/mdbook-trpl-listing
+$ cargo install --locked --path packages/mdbook-trpl-note
+```
+
 ## Building
 
 ### With cargo-make
@@ -94,7 +104,8 @@ $ start chrome.exe .\book\index.html            # Windows (Cmd)
 To run the tests:
 
 ```bash
-$ mdbook test
+$ cd packages/trpl
+$ mdbook test --library-path packages/trpl/target/debug/deps
 ```
 
 ## Contributing

book.toml

@@ -10,6 +10,7 @@ additional-css = [
   "ferris.css",
   "theme/semantic-notes.css", 
   "theme/listing.css",
+  "theme/2018-edition.css",
   "js-extensions/packages/consent-form/dist/index.css",
   "js-extensions/packages/feedback/dist/index.css",  
 ]
@@ -39,4 +40,7 @@ more-words = "words.dic"
 [preprocessor.trpl-listing]
 output-mode = "default"
 
-# [output.linkcheck]
+# [output.linkcheck]
+
+[rust]
+edition = "2021"

ci/dictionary.txt

@@ -55,6 +55,7 @@ bool
 boolean
 Boolean
 Booleans
+booleans
 Bors
 BorrowMutError
 BoxMeUp
@@ -109,6 +110,7 @@ deallocate
 deallocated
 deallocating
 deallocation
+debounce
 debuginfo
 decl
 decrementing
@@ -145,10 +147,12 @@ DisplayBacktrace
 DivAssign
 DraftPost
 DSTs
+durations
 ebook
 ebooks
 Edsger
 egular
+ElementRef
 else's
 emoji
 encodings
@@ -179,6 +183,7 @@ filesystem's
 filesystems
 filmmaking
 Firefox
+FirstAwaitPoint
 FnMut
 FnOnce
 formatter
@@ -187,6 +192,8 @@ FrenchToast
 FromIterator
 FromResidual
 frontend
+FuturesUnordered
+GetAwaitPoint
 getrandom
 getter
 getters
@@ -197,6 +204,7 @@ grapheme
 Grapheme
 growable
 gzip
+handoff
 hardcode
 hardcoded
 hardcoding
@@ -241,7 +249,9 @@ inline
 instantiation
 internet
 interoperate
+IntoFuture
 IntoIterator
+intra
 InvalidDigit
 invariants
 ioerror
@@ -256,6 +266,7 @@ isize
 iter
 iterator's
 JavaScript
+JoinAll
 JoinHandle
 Kay's
 kinded
@@ -288,12 +299,15 @@ lval
 macOS
 Matsakis
 mathematic
+mdbook
 memoization
 metadata
 Metadata
 metaprogramming
 mibbit
 Mibbit
+microcontroller
+microcontrollers
 millis
 minigrep
 mixup
@@ -307,17 +321,20 @@ monomorphized
 MoveMessage
 Mozilla
 mpsc
+MSRV
 msvc
 MulAssign
 multibyte
 multithreaded
+multithreading
 mutex
 mutex's
 Mutex
 mutexes
 Mutexes
 MutexGuard
 mutext
+MyAsyncStateMachine
 MyBox
 myprogram
 namespace
@@ -358,7 +375,9 @@ OurError
 OutlinePrint
 overloadable
 overread
+PageTitleFuture
 PanicPayload
+parallelizable
 param
 parameterize
 ParseIntError
@@ -371,6 +390,7 @@ PlaceholderType
 polymorphism
 PoolCreationError
 portia
+postfix
 powershell
 PowerShell
 powi
@@ -396,6 +416,8 @@ RangeTo
 RangeFull
 README
 READMEs
+ReadFinished
+ReceiverStream
 rect
 recurse
 recv
@@ -438,6 +460,7 @@ sampleproject
 screenshot
 searchstring
 SecondaryColor
+SecondAwaitPoint
 SelectBox
 semver
 SemVer
@@ -455,6 +478,7 @@ SliceIndex
 Smalltalk
 snuck
 someproject
+SomeType
 someusername
 SPDX
 spdx
@@ -470,6 +494,7 @@ stdlib
 stdout
 steveklabnik's
 stringify
+StreamExt
 Stroustrup
 Stroustrup's
 struct
@@ -502,6 +527,7 @@ TcpListener
 TcpStream
 templating
 test's
+TextAwaitPoint
 TextField
 That'd
 there'd
@@ -514,6 +540,8 @@ tlborm
 tlsv
 TODO
 TokenStream
+Tokio
+tokio
 toml
 TOML
 toolchain
@@ -538,6 +566,7 @@ uncomment
 Uncomment
 uncommenting
 unevaluated
+unhandled
 Uninstalling
 uninstall
 unittests
@@ -556,6 +585,7 @@ username
 USERPROFILE
 usize
 UsState
+util
 utils
 vals
 variable's