Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

More edits to the async chapter #4033

Open
wants to merge 29 commits into
base: only-new-async
Choose a base branch
from
Open

Commits on Aug 24, 2024

  1. Ch. 17: Fix up diagrams

    - Set their view boxes to the original height and width, so they are
      guaranteed to present correctly.
    - For Figure 17-02, use the trick of adding a hidden node and hidden
      arrow to it in “Task 2” to align the two boxes.
    chriskrycho committed Aug 24, 2024
    Configuration menu
    Copy the full SHA
    a42f27b View commit details
    Browse the repository at this point in the history
  2. Configuration menu
    Copy the full SHA
    f812ed0 View commit details
    Browse the repository at this point in the history

Commits on Aug 30, 2024

  1. Configuration menu
    Copy the full SHA
    c648c0e View commit details
    Browse the repository at this point in the history

Commits on Aug 31, 2024

  1. Configuration menu
    Copy the full SHA
    ef4a518 View commit details
    Browse the repository at this point in the history

Commits on Sep 3, 2024

  1. Ch. 17: start restructuring chapter

    - Create a section (which will be deleted or at least reintegrated once
      all is said and done) to hold content pulled out of other sections for
      the sake of clearer flow and understanding.
    - Pull “advanced” material from 17.00, 17.01, and 17.02 into the holding
      section and start reorganizing their content to account for shifting
      around materials.
    chriskrycho committed Sep 3, 2024
    Configuration menu
    Copy the full SHA
    1de14c8 View commit details
    Browse the repository at this point in the history

Commits on Sep 11, 2024

  1. Upgrade to Rust 1.81

    In addition to the baseline changes, skip over non-directory code where
    directories are needed to deal with things like `.DS_Store` files. Also
    add a bunch of context on error causes from `std::io::Error` because it
    was *impossible* to figure out exactly what the source of those were.
    chriskrycho committed Sep 11, 2024
    Configuration menu
    Copy the full SHA
    6b6b450 View commit details
    Browse the repository at this point in the history
  2. Merge pull request #4031 from rust-lang/rust-1.81

    Upgrade to Rust 1.81
    chriskrycho committed Sep 11, 2024
    Configuration menu
    Copy the full SHA
    589ce6b View commit details
    Browse the repository at this point in the history
  3. Configuration menu
    Copy the full SHA
    299fd1f View commit details
    Browse the repository at this point in the history
  4. Merge pull request #4024 from bin-wang/remove-mut

    Use immutable borrow of `TcpStream` when creating `BufReader`
    chriskrycho committed Sep 11, 2024
    Configuration menu
    Copy the full SHA
    28a2444 View commit details
    Browse the repository at this point in the history
  5. Merge pull request #4025 from ficcialfaint/cargo-init

    Add `cargo init` usage suggestion to 1.3
    chriskrycho committed Sep 11, 2024
    Configuration menu
    Copy the full SHA
    e2b7246 View commit details
    Browse the repository at this point in the history
  6. Configuration menu
    Copy the full SHA
    d5932d2 View commit details
    Browse the repository at this point in the history

Commits on Sep 12, 2024

  1. Merge pull request #4032 from rust-lang/updated-build-instructions

    Update build instructions: include mdbook plugins
    chriskrycho committed Sep 12, 2024
    Configuration menu
    Copy the full SHA
    2b07207 View commit details
    Browse the repository at this point in the history
  2. Ch. 17: rename trpl::block_on to trpl::run

    The `block_on` name is what both Tokio and smol use, but it is a bit
    obscure from the point of view of introducing this material. `run` says
    much more clearly what it does *for the level we care about here*, I
    think.
    chriskrycho committed Sep 12, 2024
    Configuration menu
    Copy the full SHA
    c552952 View commit details
    Browse the repository at this point in the history
  3. Ch. 17: more edits for first three sections

    These make up *most* of the rest of the edits I caught while rereading
    which are not *major structural revisions*, along with some of the bits
    required for those major structural revisions.
    chriskrycho committed Sep 12, 2024
    Configuration menu
    Copy the full SHA
    cd12a1e View commit details
    Browse the repository at this point in the history
  4. Configuration menu
    Copy the full SHA
    487c81d View commit details
    Browse the repository at this point in the history
  5. Configuration menu
    Copy the full SHA
    9b13b95 View commit details
    Browse the repository at this point in the history
  6. Configuration menu
    Copy the full SHA
    3cfdf2d View commit details
    Browse the repository at this point in the history
  7. Ch. 17: rework 17.04 with my own edits and analysis

    This does *not* yet incorporate any of the relevant feedback from Carol
    on this, so a couple spots are still pretty messy.
    chriskrycho committed Sep 12, 2024
    Configuration menu
    Copy the full SHA
    97902d5 View commit details
    Browse the repository at this point in the history
  8. Ch. 17: rework 17.05 with my own edits and analysis

    Along with the wording and phrasing-level edits, pull out a fair bit of
    material for the “advanced” section at the end, specifically the details
    of what `Stream` and `StreamExt` actually do.
    chriskrycho committed Sep 12, 2024
    Configuration menu
    Copy the full SHA
    68049c6 View commit details
    Browse the repository at this point in the history
  9. Configuration menu
    Copy the full SHA
    0d8da8b View commit details
    Browse the repository at this point in the history
  10. Configuration menu
    Copy the full SHA
    7da825f View commit details
    Browse the repository at this point in the history
  11. Configuration menu
    Copy the full SHA
    6bdf1b7 View commit details
    Browse the repository at this point in the history
  12. Ch. 17: integrate a number of the outstanding review comments

    Bonus: fix some style guide issues, too!
    
    Co-authored-by: Carol (Nichols || Goulding) <carol.nichols@gmail.com>
    Co-authored-by: James Munns <james@onevariable.com>
    Co-authored-by: Tim McNamara <paperless@timmcnamara.co.nz>
    4 people committed Sep 12, 2024
    Configuration menu
    Copy the full SHA
    1d3517c View commit details
    Browse the repository at this point in the history
  13. Ch. 17: address the rest of James’ review comments 🎉

    Co-authored-by: James Munns <james@onevariable.com>
    chriskrycho and jamesmunns committed Sep 12, 2024
    Configuration menu
    Copy the full SHA
    c4d02bf View commit details
    Browse the repository at this point in the history

Commits on Sep 13, 2024

  1. Configuration menu
    Copy the full SHA
    c35b7d9 View commit details
    Browse the repository at this point in the history
  2. Ch. 17: address Tim and Carol's outstanding comments

    Co-authored-by: Tim McNamara <paperless@timmcnamara.co.nz>
    Co-authored-by: Carol (Nichols || Goulding) <carol.nichols@gmail.com>
    3 people committed Sep 13, 2024
    Configuration menu
    Copy the full SHA
    453247c View commit details
    Browse the repository at this point in the history
  3. Ch. 17: Fix some typos!

    chriskrycho committed Sep 13, 2024
    Configuration menu
    Copy the full SHA
    ccafd06 View commit details
    Browse the repository at this point in the history

Commits on Sep 16, 2024

  1. Remove duplicate integration test from root

    I accidentally copied these in when pulling in the `trpl-note` mdbook
    preprocessor many months ago, and we did not notice amidst the many
    other changes in that PR!
    chriskrycho committed Sep 16, 2024
    Configuration menu
    Copy the full SHA
    6f5773e View commit details
    Browse the repository at this point in the history

Commits on Sep 20, 2024

  1. Ch. 17: rewrite 17.01 with a better example

    Add `reqwest` and `scraper` dependencies to the `trpl` crate. Wrap them
    in `trpl` re-exports which keep the API surface low.
    
    Rewrite the whole first section to use `race` along with those `trpl`
    re-exports to show a more “real” example of async code right form the
    start, including actual concurrency, unlike the previous introduction.
    
    Update 17.03 to account for having introduced `race` already, and update
    listing numbers for rewritten 17.01.
    chriskrycho committed Sep 20, 2024
    Configuration menu
    Copy the full SHA
    5b75c32 View commit details
    Browse the repository at this point in the history