Update to Rust 2024 edition. (#2658)

Author: qwandor

.github/workflows/build.sh

@@ -25,7 +25,7 @@ else
     # Back-date the sources to POT-Creation-Date. The content lives in two
     # directories:
     rm -r src/ third_party/
-    git restore --source "$(git rev-list -n 1 --before "$pot_creation_date" @)" src/ third_party/
+    git restore --source "$(git rev-list -n 1 --before "$pot_creation_date" @)" src/ third_party/ book.toml
     # Set language and adjust site URL. Clear the redirects since they are
     # in sync with the source files, not the translation.
     export MDBOOK_BOOK__LANGUAGE=$book_lang

.github/workflows/build.yml

@@ -161,9 +161,11 @@ jobs:
           MDBOOK_OUTPUT='{"xgettext": {"pot-file": "messages.pot"}}' mdbook build -d po
           msgfmt -o /dev/null --statistics po/messages.pot
 
-      - name: Install mdbook-linkcheck
+      - name: Install mdbook-linkcheck2
         if: contains(fromJSON(env.LINK_CHECKED_LANGUAGES), matrix.language)
-        run: cargo install mdbook-linkcheck --locked --version 0.7.7
+        run: |
+          cargo uninstall mdbook-linkcheck || true
+          cargo install mdbook-linkcheck2 --locked --version 0.9.1
 
       - name: Build ${{ matrix.language }} translation
         run: |
@@ -210,6 +212,9 @@ jobs:
         with:
           fetch-depth: 0
 
+      - name: Update Rust
+        run: rustup update
+
       - name: Setup Rust cache
         uses: ./.github/workflows/setup-rust-cache
 

.github/workflows/install-mdbook/action.yml

@@ -13,6 +13,6 @@ runs:
       run: |
         sudo apt-get update
         sudo apt-get install -y texlive texlive-luatex texlive-lang-cjk texlive-lang-arabic librsvg2-bin fonts-noto
-        curl -LsSf https://github.com/jgm/pandoc/releases/download/3.6.2/pandoc-3.6.2-linux-amd64.tar.gz | tar zxf -
-        echo "$PWD/pandoc-3.6.2/bin" >> $GITHUB_PATH
+        curl -LsSf https://github.com/jgm/pandoc/releases/download/3.7.0.1/pandoc-3.7.0.1-linux-amd64.tar.gz | tar zxf -
+        echo "$PWD/pandoc-3.7.0.1/bin" >> $GITHUB_PATH
       shell: bash

.github/workflows/publish.yml

@@ -35,6 +35,9 @@ jobs:
         with:
           fetch-depth: 0 # We need the full history for build.sh below.
 
+      - name: Update Rust
+        run: rustup update
+
       - name: Setup Rust cache
         uses: ./.github/workflows/setup-rust-cache
 

README.md

@@ -55,7 +55,7 @@ The course is built using a few tools:
 - [mdbook-i18n-helpers and i18n-report](https://github.com/google/mdbook-i18n-helpers)
 - [mdbook-exerciser](mdbook-exerciser/)
 - [mdbook-course](mdbook-course/)
-- [mdbook-linkcheck](https://github.com/Michael-F-Bryan/mdbook-linkcheck)
+- [mdbook-linkcheck2](https://github.com/marxin/mdbook-linkcheck2)
 
 First install Rust by following the instructions on https://rustup.rs/. Then
 clone this repository:

book.toml

@@ -5,7 +5,7 @@ src = "src"
 title = "Comprehensive Rust 🦀"
 
 [rust]
-edition = "2021"
+edition = "2024"
 
 [build]
 extra-watch-dirs = ["po", "third_party"]
@@ -299,3 +299,12 @@ exclude = [
   "comprehensive-rust-exercises.zip",
   # "crates.io", # uncomment when follow-web-links is true
 ]
+
+[output.linkcheck2]
+optional = true
+follow-web-links = false # change to true to check web links
+exclude = [
+  "comprehensive-rust.pdf",
+  "comprehensive-rust-exercises.zip",
+  # "crates.io", # uncomment when follow-web-links is true
+]

dprint.json

@@ -9,7 +9,7 @@
       "command": "yapf3",
       "exts": ["py"]
     }, {
-      "command": "rustup run stable rustfmt --edition 2021",
+      "command": "rustup run stable rustfmt --edition 2024",
       "exts": ["rs"]
     }]
   },

mdbook-course/Cargo.toml

@@ -2,7 +2,7 @@
 name = "mdbook-course"
 version = "0.1.0"
 authors = ["Dustin Mitchell <[email protected]>"]
-edition = "2021"
+edition = "2024"
 license = "Apache-2.0"
 publish = false
 repository = "https://github.com/google/comprehensive-rust"

mdbook-course/src/course.rs

@@ -35,8 +35,8 @@
 //! item becomes the first slide in that segment. Any other sub-items of the
 //! top-level item are treated as further slides in the same segment.
 
-use crate::frontmatter::{split_frontmatter, Frontmatter};
-use crate::markdown::{duration, Table};
+use crate::frontmatter::{Frontmatter, split_frontmatter};
+use crate::markdown::{Table, duration};
 use mdbook::book::{Book, BookItem, Chapter};
 use std::fmt::Write;
 use std::path::PathBuf;
@@ -318,7 +318,9 @@ impl Session {
         }
         format!(
             "Including {BREAK_DURATION} minute breaks, this session should take about {}. It contains:\n\n{}",
-            duration(self.minutes()), segments)
+            duration(self.minutes()),
+            segments
+        )
     }
 
     /// Return the total duration of this session.
@@ -337,11 +339,7 @@ impl Session {
     ///
     /// This includes breaks between segments.
     pub fn target_minutes(&self) -> u64 {
-        if self.target_minutes > 0 {
-            self.target_minutes
-        } else {
-            self.minutes()
-        }
+        if self.target_minutes > 0 { self.target_minutes } else { self.minutes() }
     }
 }
 

mdbook-exerciser/Cargo.toml

@@ -2,7 +2,7 @@
 name = "mdbook-exerciser"
 version = "0.1.0"
 authors = ["Andrew Walbran <[email protected]>"]
-edition = "2021"
+edition = "2024"
 license = "Apache-2.0"
 repository = "https://github.com/google/comprehensive-rust"
 description = "A tool for extracting starter code for exercises from Markdown files."

mdbook-exerciser/src/lib.rs

@@ -14,7 +14,7 @@
 
 use log::{info, trace};
 use pulldown_cmark::{Event, Parser, Tag, TagEnd};
-use std::fs::{create_dir_all, File};
+use std::fs::{File, create_dir_all};
 use std::io::Write;
 use std::path::Path;
 

mdbook-exerciser/src/main.rs

@@ -14,9 +14,9 @@
 
 use anyhow::Context;
 use log::trace;
+use mdbook::BookItem;
 use mdbook::book::Book;
 use mdbook::renderer::RenderContext;
-use mdbook::BookItem;
 use mdbook_exerciser::process;
 use std::fs::{create_dir, remove_dir_all};
 use std::io::stdin;

src/android/interoperability/java/src/lib.rs

@@ -15,9 +15,9 @@
 // ANCHOR: hello
 //! Rust <-> Java FFI demo.
 
+use jni::JNIEnv;
 use jni::objects::{JClass, JString};
 use jni::sys::jstring;
-use jni::JNIEnv;
 
 /// HelloWorld::hello method implementation.
 // SAFETY: There is no other global function of this name.

src/android/testing/Cargo.toml

@@ -1,7 +1,7 @@
 [package]
 name = "android-testing"
 version = "0.1.0"
-edition = "2021"
+edition = "2024"
 publish = false
 
 [[example]]

src/bare-metal/alloc-example/Cargo.toml

@@ -3,7 +3,7 @@
 [package]
 name = "alloc-example"
 version = "0.1.0"
-edition = "2021"
+edition = "2024"
 publish = false
 
 [dependencies]

src/bare-metal/alloc-example/src/main.rs

@@ -26,13 +26,14 @@ use buddy_system_allocator::LockedHeap;
 #[global_allocator]
 static HEAP_ALLOCATOR: LockedHeap<32> = LockedHeap::<32>::new();
 
-static mut HEAP: [u8; 65536] = [0; 65536];
+const HEAP_SIZE: usize = 65536;
+static mut HEAP: [u8; HEAP_SIZE] = [0; HEAP_SIZE];
 
 pub fn entry() {
     // SAFETY: `HEAP` is only used here and `entry` is only called once.
     unsafe {
         // Give the allocator some memory to allocate.
-        HEAP_ALLOCATOR.lock().init(HEAP.as_mut_ptr() as usize, HEAP.len());
+        HEAP_ALLOCATOR.lock().init(&raw mut HEAP as usize, HEAP_SIZE);
     }
 
     // Now we can do things that require heap allocation.

src/bare-metal/aps/examples/Cargo.toml

@@ -3,7 +3,7 @@
 [package]
 name = "ap-examples"
 version = "0.1.0"
-edition = "2021"
+edition = "2024"
 publish = false
 
 [dependencies]

src/bare-metal/aps/examples/src/exceptions.rs

@@ -14,8 +14,8 @@
 
 // ANCHOR: exceptions
 use log::error;
-use smccc::psci::system_off;
 use smccc::Hvc;
+use smccc::psci::system_off;
 
 // SAFETY: There is no other global function of this name.
 #[unsafe(no_mangle)]

src/bare-metal/aps/examples/src/main_improved.rs

@@ -23,8 +23,8 @@ use crate::pl011::Uart;
 use core::fmt::Write;
 use core::panic::PanicInfo;
 use log::error;
-use smccc::psci::system_off;
 use smccc::Hvc;
+use smccc::psci::system_off;
 
 /// Base address of the primary PL011 UART.
 const PL011_BASE_ADDRESS: *mut u32 = 0x900_0000 as _;

src/bare-metal/aps/examples/src/main_logger.rs

@@ -22,9 +22,9 @@ mod pl011;
 
 use crate::pl011::Uart;
 use core::panic::PanicInfo;
-use log::{error, info, LevelFilter};
-use smccc::psci::system_off;
+use log::{LevelFilter, error, info};
 use smccc::Hvc;
+use smccc::psci::system_off;
 
 /// Base address of the primary PL011 UART.
 const PL011_BASE_ADDRESS: *mut u32 = 0x900_0000 as _;

src/bare-metal/aps/examples/src/main_minimal.rs

@@ -24,8 +24,8 @@ use crate::pl011_minimal::Uart;
 use core::fmt::Write;
 use core::panic::PanicInfo;
 use log::error;
-use smccc::psci::system_off;
 use smccc::Hvc;
+use smccc::psci::system_off;
 
 /// Base address of the primary PL011 UART.
 const PL011_BASE_ADDRESS: *mut u8 = 0x900_0000 as _;

src/bare-metal/aps/examples/src/main_rt.rs

@@ -19,14 +19,14 @@
 mod exceptions;
 
 use aarch64_paging::paging::Attributes;
-use aarch64_rt::{entry, initial_pagetable, InitialPagetable};
+use aarch64_rt::{InitialPagetable, entry, initial_pagetable};
 use arm_pl011_uart::{PL011Registers, Uart, UniqueMmioPointer};
 use core::fmt::Write;
 use core::panic::PanicInfo;
 use core::ptr::NonNull;
 use log::error;
-use smccc::psci::system_off;
 use smccc::Hvc;
+use smccc::psci::system_off;
 
 /// Base address of the primary PL011 UART.
 const PL011_BASE_ADDRESS: NonNull<PL011Registers> =

src/bare-metal/microcontrollers/examples/Cargo.toml

@@ -3,7 +3,7 @@
 [package]
 name = "microcontroller-examples"
 version = "0.1.0"
-edition = "2021"
+edition = "2024"
 publish = false
 
 [dependencies]

src/bare-metal/microcontrollers/examples/src/bin/hal.rs

@@ -20,7 +20,7 @@ extern crate panic_halt as _;
 
 use cortex_m_rt::entry;
 use embedded_hal::digital::OutputPin;
-use nrf52833_hal::gpio::{p0, Level};
+use nrf52833_hal::gpio::{Level, p0};
 use nrf52833_hal::pac::Peripherals;
 
 #[entry]

src/bare-metal/useful-crates/allocator-example/Cargo.toml

@@ -1,7 +1,7 @@
 [package]
 name = "allocator-example"
 version = "0.1.0"
-edition = "2021"
+edition = "2024"
 publish = false
 
 [dependencies]

src/bare-metal/useful-crates/tinyvec.md

@@ -8,7 +8,7 @@ many elements are used and panics if you try to use more than are allocated.
 <!-- mdbook-xgettext: skip -->
 
 ```rust,editable,compile_fail
-use tinyvec::{array_vec, ArrayVec};
+use tinyvec::{ArrayVec, array_vec};
 
 fn main() {
     let mut numbers: ArrayVec<[u32; 5]> = array_vec!(42, 66);

src/bare-metal/useful-crates/zerocopy-example/Cargo.toml

@@ -1,7 +1,7 @@
 [package]
 name = "zerocopy-example"
 version = "0.1.0"
-edition = "2021"
+edition = "2024"
 publish = false
 
 [dependencies]

src/borrowing/Cargo.toml

@@ -1,7 +1,7 @@
 [package]
 name = "borrowing"
 version = "0.1.0"
-edition = "2021"
+edition = "2024"
 publish = false
 
 [lib]

src/borrowing/borrowck.md

@@ -82,5 +82,5 @@ fn main() {
 
 </details>
 
-[1]: https://play.rust-lang.org/?version=stable&mode=debug&edition=2021&gist=8f5896878611566845fe3b0f4dc5af68
-[2]: https://play.rust-lang.org/?version=stable&mode=debug&edition=2021&gist=f293a31f2d4d0d31770486247c2e8437
+[1]: https://play.rust-lang.org/?version=stable&mode=debug&edition=2024&gist=8f5896878611566845fe3b0f4dc5af68
+[2]: https://play.rust-lang.org/?version=stable&mode=debug&edition=2024&gist=f293a31f2d4d0d31770486247c2e8437

src/borrowing/shared.md

@@ -72,4 +72,4 @@ Notes on stack returns and inlining:
 
 </details>
 
-[Playground]: https://play.rust-lang.org/?version=stable&mode=release&edition=2021&gist=0cb13be1c05d7e3446686ad9947c4671
+[Playground]: https://play.rust-lang.org/?version=stable&mode=release&edition=2024&gist=0cb13be1c05d7e3446686ad9947c4671

src/cargo/rust-ecosystem.md

@@ -32,8 +32,8 @@ Key points:
 - Dependencies can also be resolved from alternative [registries], git, folders,
   and more.
 
-- Rust also has [editions]: the current edition is Rust 2021. Previous editions
-  were Rust 2015 and Rust 2018.
+- Rust also has [editions]: the current edition is Rust 2024. Previous editions
+  were Rust 2015, Rust 2018 and Rust 2021.
 
   - The editions are allowed to make backwards incompatible changes to the
     language.

src/closures/capturing.md

@@ -10,11 +10,7 @@ A closure can capture variables from the environment where it was defined.
 fn main() {
     let max_value = 5;
     let clamp = |v| {
-        if v > max_value {
-            max_value
-        } else {
-            v
-        }
+        if v > max_value { max_value } else { v }
     };
 
     dbg!(clamp(1));

src/concurrency/async-control-flow/select.md

@@ -17,7 +17,7 @@ the resulting variables. The `statement` result becomes the result of the
 
 ```rust,editable,compile_fail
 use tokio::sync::mpsc;
-use tokio::time::{sleep, Duration};
+use tokio::time::{Duration, sleep};
 
 #[tokio::main]
 async fn main() {

src/concurrency/async-exercises/chat-async/Cargo.toml

@@ -1,7 +1,7 @@
 [package]
 name = "chat-async"
 version = "0.1.0"
-edition = "2021"
+edition = "2024"
 
 [dependencies]
 futures-util = { version = "0.3.31", features = ["sink"] }

src/concurrency/async-exercises/chat-async/src/bin/client.rs

@@ -14,8 +14,8 @@
 
 // ANCHOR: solution
 // ANCHOR: setup
-use futures_util::stream::StreamExt;
 use futures_util::SinkExt;
+use futures_util::stream::StreamExt;
 use http::Uri;
 use tokio::io::{AsyncBufReadExt, BufReader};
 use tokio_websockets::{ClientBuilder, Message};