[WIP] `async` and `.await` chapter - #3909

Closed

carols10cents wants to merge 214 commits into

mainfrom

Commits on Apr 24, 2024

Create crate for The Rust Programming Language
chriskrycho
committed
0ec7296
Add Tokio dependency
chriskrycho
committed
fcd470c
Re-export `tokio::main` as `trpl::async_main` and test it.
chriskrycho
committed
3943e51
Add more crate-level docs and matching README materials.
chriskrycho
committed
e518289
Document the first test so people can understand it.
chriskrycho
committed
608c35b
Add CI for `main` and PRs against `main`
chriskrycho
committed
71ea12e
Add a CI status badge
chriskrycho
committed
4255d87

Commits on Apr 30, 2024

Add new Chapter 17: Async and Await

chriskrycho
authored and
carols10cents
committed
7c40849
Ch. 17: introduction section

chriskrycho
authored and
carols10cents
committed
c1a0d14
Ch. 17: Expand introduction and add stub for tasks chapter

chriskrycho
authored and
carols10cents
committed
d17c712
Ch. 17: Fix a couple typos and incomplete sentences

chriskrycho
authored and
carols10cents
committed
4ce722d
Ch. 17: Add some introductory material about async/await

chriskrycho
authored and
carols10cents
committed
71d92ec
Ch. 17: Introduce runtimes and the `trpl` crate

chriskrycho
authored and
carols10cents
committed
fdb3794

Commits on May 1, 2024

Commits on May 9, 2024

Ch. 17: fix a misplaced period
chriskrycho
committed
63baf22
Ch. 17: get to working async code sooner
chriskrycho
committed
c31d308
Merge `main` into `only-new-async`
chriskrycho
committed
0721b04
Ch. 17: add to table of contents so `mdbook serve` is useful
chriskrycho
committed
dee7220
Ch. 17: clarify language about Tokio
chriskrycho
committed
5b3c27e
Ch. 17: use `trpl`, not `futures`, even for initial code samples
chriskrycho
committed
ebebf8c
Ch. 17: text/code ordering fix in 17.02
chriskrycho
committed
ee0704d
Prepare to integrate into TRPL repo
chriskrycho
committed
40df049
Ch. 17: merge in trpl crate
chriskrycho
committed
a150365

Commits on May 10, 2024

Merge `main` into `only-new-async`
chriskrycho
committed
45bda34
Ch. 17: expand, clarify, and restructure 17.01
chriskrycho
committed
8f6bcc7

Commits on Jun 12, 2024

Ch. 17: reorganize 17.01 and get a useable intro to Future
chriskrycho
committed
0c00b17
Ch. 17: wording and formatting in 17.01
chriskrycho
committed
23027cb
Ch. 17: corrections/discussion on runtimes, mostly
chriskrycho
committed
3cf4fae
Ch. 17: pull disconnected material out of 17.01
chriskrycho
committed
c3ebabe
Ch. 17: minor wording improvement
chriskrycho
committed
5657a49
Ch. 17: use `Listing` for all existing listings
chriskrycho
committed
dbd5e14
Ch. 17: eliminate duplicate runtime description
chriskrycho
committed
b4e3030
Merge `main` into `only-new-async`
chriskrycho
committed
96fd725
Ch. 17: Add `futures` to `trpl` crate for re-exports
chriskrycho
committed
95105d2
Ch. 17: abandon attempt to re-export `tokio::main`
chriskrycho
committed
f418ceb
Ch. 17: start in earnest on §2, showing relation to threads
chriskrycho
committed
8e7420e
Ch. 17: add more examples and explanation to §02.
chriskrycho
committed
1ee7975
Ch. 17: Finish 'Counting', start on 'Async Move Blocks'
chriskrycho
committed
9c1f4c8
Merge `main` into `only-new-async`
chriskrycho
committed
dacddb5
Ch. 17: start on message-passing and `async move` in §2
chriskrycho
committed
c1c3c7f
Ch. 17: Finish a pass on Message Passing example
chriskrycho
committed
4b7886e
Merge `main` into `only-new-async`
chriskrycho
committed
b835c07
Merge `main` into `only-new-async`
chriskrycho
committed
5e09f02
Exclude `trpl` from workspace
chriskrycho
committed
5483299
Ch. 17: skip `main` and `trpl::block_on` in some listings
chriskrycho
committed
acde825
Ch. 17: inline some note content and fix some phrasing
chriskrycho
committed
7b14d7d
Merge `main` into `only-new-async`
chriskrycho
committed
89b3b25
Ch. 17: Rewrite listings to be more similar to Ch. 16
chriskrycho
committed
1d7c987
Ch. 17: wording and structure tweaks
chriskrycho
committed
1db4ee2
Ch. 17: show multiple producers working with `clone`
chriskrycho
committed
af18d2b
Merge `main` into `only-new-async`
chriskrycho
committed
b3fe5b7
Ch. 17: restructure §00 and start better motivating async
chriskrycho
committed
c1847bf
Ch. 17: further motivation for async w/examples
chriskrycho
committed
1010b1f
Ch. 17: rework §00 to talk about reads instead of writes
chriskrycho
committed
8ce6c8a
Ch. 17: extract parallelism discussion from §00 to §03
chriskrycho
committed
52bf9e4
Ch. 17: dedicate §03 to 'Futures, Tasks, and Threads'
chriskrycho
committed
3224ceb
Ch. 17: Listings are all `17-*`!
chriskrycho
committed
82f47c3
Ch. 17: Fill out message-passing example
chriskrycho
committed
91ffec8
Merge `main` into `only-new-async`
chriskrycho
committed
d3d7c64
Ch. 17: A minor wording improvement
chriskrycho
committed
91348ca
Ch 17.02: motivating `futures::join!` and `Box::pin`
chriskrycho
committed
068f30b
Ch. 17: finish motivating `Pin` and `pin!`
chriskrycho
committed
7a5bdb2
Ch. 17: A small wording tweak about `JoinAll` in §03
chriskrycho
committed
626aec8
Merge `main` into `only-new-async`
chriskrycho
committed
40a3dc1
Ch. 17: Start building out explanation of `Pin`
chriskrycho
committed
b382767
Ch. 17: Iterate on explanation of `Pin` and `Unpin`
chriskrycho
committed
e000ea3
Ch. 17: iterate on §02 examples, extract “extra” material
chriskrycho
committed
0032e07
Ch. 17: Explain `join!` in §02
chriskrycho
committed
4236371
Ch. 17 §02: Clarify the `move` discussion
chriskrycho
committed
97f5bcc
Merge `main` into `only-new-async`
chriskrycho
committed
888a519
Ch. 17 §02: Start showing timeouts
chriskrycho
committed
c6965ca
Ch. 17 §02: Start on example of select.
chriskrycho
committed
c58f943
Ch. 17 §02: Implement `timeout` example and building blocks
chriskrycho
committed
7da440a
Ch. 17: build a `retry` implementation
chriskrycho
committed
270780a
Ch. 17: Drop material about `retry`, since it is a hazard
chriskrycho
committed
1c27c97
Ch. 17 §02: Write about `race` and `yield_now`
chriskrycho
committed
71acd6d
Ch. 17: Split the over-long §02 into two parts
chriskrycho
committed
5a0fb42
Ch. 17: Show worked example of implementing `timeout`
chriskrycho
committed
86835d6
Ch. 17 §04: Show perforance of `sleep` vs. `yield_now`
chriskrycho
committed
a364865
Ch. 17 §01: rephrase note about the details we don’t get into
chriskrycho
committed
f4cd9d2
Ch. 17 §01: Add necessary background for §04 to make sense
chriskrycho
committed
b5010d1
Ch. 17 §04: Explain the *implications* of yielding to motivate it
chriskrycho
committed
13adef4
Ch. 17 §04: explain yield better and rework examples
chriskrycho
committed
54a18a7
Ch. 17 §04: Add a good transition sentence
chriskrycho
committed
e56e906
Ch. 17 §04: add a Note about cooperative multitasking
chriskrycho
committed
95422ab
Ch. 17 §03: Add more explanatory material on `Pin`
chriskrycho
committed
b3931ef
Ch. 17: a better name for one of the internal sections
chriskrycho
committed
8809d9f
Ch. 17 §03: Explain pinning and `Deref` just enough
chriskrycho
committed
121f5b6
Ch. 17 §03: Finish a first pass on explaining `Pin`
chriskrycho
committed
a97358e
Ch. 17 §04: Code sample and incomplete sentence fixes
chriskrycho
committed
644bc54
Merge `main` into `only-new-async`
chriskrycho
committed
b796ff8
Ch. 17 §04: Give the section a reasonable title
chriskrycho
committed
f786162
Merge `main` into `only-new-async`
chriskrycho
committed
39485b9
Ch. 17: an editing pass on §00 and the start of §01
chriskrycho
committed
617b755
Ch. 17: reduce dependency list for `trpl` crate
chriskrycho
committed
2360484

Commits on Jun 13, 2024

Commits on Jun 14, 2024

Commits on Jun 17, 2024

Ch. 17 §01: make the conclusion section coherent
chriskrycho
committed
4598e2c
Ch. 17 §02: transition for §03 and TODO cleanup
chriskrycho
committed
c0c24e2
Ch. 17: Add a new §05 on Stream and AsyncIterator
chriskrycho
committed
74df84e

Commits on Jun 18, 2024

Commits on Jun 19, 2024

Ch 17. §01: leave a TODO about `IntoFuture`
chriskrycho
committed
ad360d7
Ch. 17 §05: start explaining how we work with streams
chriskrycho
committed
52c516c

Commits on Jun 20, 2024

Commits on Jun 25, 2024

Commits on Jun 26, 2024

Ch. 17 §06: Start discussing future/task/thread tradeoffs
chriskrycho
committed
bea8557
Merge `main` into `only-new-async`
chriskrycho
committed
a8fe2d6
Ch. 17 §06: more on tasks and threads, better example
chriskrycho
committed
bdd8f3e
Ch. 17: Most of §06 drafted, needs a conclusion
chriskrycho
committed
ffb2d1b
Ch. 17 §00: rewrite the parallelism and concurrency section
chriskrycho
committed
63214c3
Ch. 17 §00: no more cooks!
chriskrycho
committed
6914bc4

Commits on Jul 1, 2024

Ch. 17: remove 'base' listing
chriskrycho
committed
e774613
Ch. 17: Transition materials from Ch. 16 and into Ch. 18
chriskrycho
committed
f039ca3
Ch. 17§00 initial edits
chriskrycho
committed
5fdd92c

Commits on Jul 2, 2024

Commits on Jul 3, 2024

Ch. 17§02 initial edits on 'Message Passing'
chriskrycho
committed
e5c9afd
Ch. 17§03 Initial edits on opening section
chriskrycho
committed
89920d5

Commits on Jul 8, 2024

Commits on Jul 9, 2024

Ch. 17§04 initial edits on Building Our Own Async Abstractions
chriskrycho
committed
ef1ed96

Commits on Jul 12, 2024

Commits on Jul 15, 2024

Ch. 17 §03: restore accidentally-removed Listing 17-14
chriskrycho
committed
c3c88e4

Commits on Jul 16, 2024

infra: prepare `trpl` crate for 0.1.0 release
chriskrycho
committed
22b04c1
Ch. 17§03: fix typo

chriskrycho
and
jamesmunns
authored
58fff3c
Ch. 17: correct wrapping for a `Note`
chriskrycho
committed
130e6d0

Commits on Jul 17, 2024

Merge `main` into `async-edits`
chriskrycho
committed
dc8d7e8
Ch. 17: Update CI config to support testing the book with `trpl`
chriskrycho
committed
bb9cdbb
Ch. 17§01: Make code/listings pass tests
chriskrycho
committed
24ed6e4
Ch. 17§02: Make code/listings pass tests
chriskrycho
committed
deefe4d
Ch. 17§03: Make code/listings pass tests
chriskrycho
committed
6a0d072
Ch. 17§04: Make code/listings pass tests
chriskrycho
committed
0aacb80
Ch. 17§05: Make code/listings pass tests
chriskrycho
committed
40bdda7
Ch. 17§06: Make code listing pass tests and add a caption
chriskrycho
committed
5099e5f

Commits on Jul 22, 2024

Commits on Jul 23, 2024

Merge `main` into `async-edits`
chriskrycho
committed
b2a2133
Ch. 17§00: phrasing/wording-level improvements

committed
e669250
Ch. 17§00: phrasing/wording-level improvements

committed
133bb61

Commits on Jul 24, 2024

Commits on Jul 25, 2024

Ch. 17: diagrams for concurrent and parallel execution
chriskrycho
committed
cfaf187

Commits on Jul 26, 2024

Ch. 17: fix diagrams and embed them in the text
chriskrycho
committed
472f152

Commits on Aug 19, 2024

Merge `main` into `async-edits`
chriskrycho
committed
fb718b3
Merge `async-edits` into `only-new-async`
chriskrycho
committed
ddad349

Commits on Aug 24, 2024

Ch. 17: Fix up diagrams
chriskrycho
committed
a42f27b
Ch. 17§00: second round of edits
chriskrycho
committed
f812ed0

Commits on Sep 3, 2024

Ch. 17: start restructuring chapter
chriskrycho
committed
1de14c8

Commits on Sep 12, 2024

Ch. 17: rename `trpl::block_on` to `trpl::run`
chriskrycho
committed
c552952
Ch. 17: more edits for first three sections
chriskrycho
committed
cd12a1e
Merge `main` into `async-edits` (Rust 1.81 update)
chriskrycho
committed
487c81d
Upgrade Ch. 17 listings for Rust 1.81
chriskrycho
committed
9b13b95
Ch. 17: rework 17.03 (and overall structure) from my own analysis
chriskrycho
committed
3cfdf2d
Ch. 17: rework 17.04 with my own edits and analysis
chriskrycho
committed
97902d5
Ch. 17: rework 17.05 with my own edits and analysis
chriskrycho
committed
68049c6
Ch. 17: fold together 17.03 and 17.04
chriskrycho
committed
0d8da8b
Ch. 17: Make the new 17.05 actually work as a deep dive!
chriskrycho
committed
7da825f
Merge `main` into `async-edits`
chriskrycho
committed
6bdf1b7
Ch. 17: integrate a number of the outstanding review comments

committed
1d3517c
Ch. 17: address the rest of James’ review comments 🎉

chriskrycho
and
jamesmunns
committed
c4d02bf

Commits on Sep 13, 2024

Ch. 17: address most of the rest of Carol's outstanding comments
chriskrycho
committed
c35b7d9
Ch. 17: address Tim and Carol's outstanding comments

committed
453247c
Ch. 17: Fix some typos!
chriskrycho
committed
ccafd06

Commits on Sep 16, 2024

Remove duplicate integration test from root
chriskrycho
committed
6f5773e

Commits on Sep 20, 2024

Ch. 17: rewrite 17.01 with a better example
chriskrycho
committed
cc5db97

Commits on Sep 23, 2024

Ch. 17: fix mdbook test output
chriskrycho
committed
573a6ca
Ch. 17: Fix spelling and internal links
chriskrycho
committed
b265249
Merge `async-edits` into `only-new-async`
chriskrycho
committed
25ca8a1