refactor: use format_args_capture (Rust RFC 2795)

yvt · yvt · commit 45da448ee223 · 2022-03-22T12:38:46.000+09:00
Updates format strings to use the implicit named arguments (`format_args_capture`) introduced in [Rust RFC 2795][1] whenever possible. | Before | After | | -------------------- | -------------------------------- | | `xxx!("{}", self.x)` | `xxx!("{}", self.x)` (no change) | | `xxx!("{}", x)` | `xxx!("{x}")` | [1]: https://rust-lang.github.io/rfcs/2795-format-args-implicit-identifiers.html
diff --git a/examples/basic_gr_peach/src/main.rs b/examples/basic_gr_peach/src/main.rs
@@ -99,7 +99,7 @@ const fn configure_app(b: &mut r3_kernel::Cfg<SystemTraits>) -> Objects {
 }
 
 fn task1_body() {
-    support_rza1::sprintln!("COTTAGE = {:?}", COTTAGE);
+    support_rza1::sprintln!("COTTAGE = {COTTAGE:?}");
 
     COTTAGE.task2.activate().unwrap();
 }
diff --git a/examples/basic_gr_peach/src/panic_serial.rs b/examples/basic_gr_peach/src/panic_serial.rs
@@ -8,7 +8,7 @@ fn panic(info: &PanicInfo) -> ! {
     // Disable IRQ
     unsafe { asm!("cpsid i") };
 
-    sprintln!("{}", info);
+    sprintln!("{info}");
 
     loop {}
 }
diff --git a/examples/basic_nucleo_f401re/src/main.rs b/examples/basic_nucleo_f401re/src/main.rs
@@ -72,7 +72,7 @@ const fn configure_app(b: &mut r3_kernel::Cfg<SystemTraits>) -> Objects {
 }
 
 fn task1_body() {
-    rtt_target::rprintln!("COTTAGE = {:?}", COTTAGE);
+    rtt_target::rprintln!("COTTAGE = {COTTAGE:?}");
 
     COTTAGE.task2.activate().unwrap();
 }
diff --git a/examples/basic_rp_pico/src/main.rs b/examples/basic_rp_pico/src/main.rs
@@ -52,7 +52,7 @@ impl support_rp2040::usbstdio::Options for SystemTraits {
 
         // echo the input with brackets
         if let Ok(s) = core::str::from_utf8(s) {
-            support_rp2040::sprint!("[{}]", s);
+            support_rp2040::sprint!("[{s}]");
         } else {
             support_rp2040::sprint!("[<not UTF-8>]");
         }
@@ -152,7 +152,7 @@ const fn configure_app(b: &mut r3_kernel::Cfg<SystemTraits>) -> Objects {
 }
 
 fn task1_body() {
-    support_rp2040::sprintln!("COTTAGE = {:?}", COTTAGE);
+    support_rp2040::sprintln!("COTTAGE = {COTTAGE:?}");
 
     COTTAGE.task2.activate().unwrap();
 }
diff --git a/examples/basic_rp_pico/src/panic_serial.rs b/examples/basic_rp_pico/src/panic_serial.rs
@@ -7,7 +7,7 @@ fn panic(info: &PanicInfo) -> ! {
     // Disable IRQ
     unsafe { asm!("cpsid i") };
 
-    r3_support_rp2040::sprintln!("{}", info);
+    r3_support_rp2040::sprintln!("{info}");
 
     loop {}
 }
diff --git a/examples/basic_wio_terminal/src/main.rs b/examples/basic_wio_terminal/src/main.rs
@@ -500,8 +500,7 @@ fn button_reporter_task_body() {
             if (st ^ new_st) & mask != 0 {
                 let _ = write!(
                     Console,
-                    "{:?}: {}",
-                    b,
+                    "{b:?}: {}",
                     ["UP", "DOWN"][(new_st & mask != 0) as usize]
                 );
             }
@@ -817,7 +816,7 @@ fn panic(info: &PanicInfo) -> ! {
 
     if let Some(lcd) = lcd.as_mut() {
         let mut msg = arrayvec::ArrayString::<256>::new();
-        if let Err(_) = write!(msg, "panic: {}", info) {
+        if let Err(_) = write!(msg, "panic: {info}") {
             msg.clear();
             msg.push_str("panic: (could not format the message)");
         }
diff --git a/examples/common/build.rs b/examples/common/build.rs
@@ -33,7 +33,7 @@ fn main() {
         write_image(
             &mut generated_code,
             out_dir,
-            &format!("animation_{}", i),
+            &format!("animation_{i}"),
             frame.buffer(),
         );
     }
@@ -61,7 +61,7 @@ fn write_image(out: &mut impl Write, dir: &Path, name: &str, image: &RgbaImage)
         .map(|image::Rgba(data)| pixelcolor::Rgb888::new(data[0], data[1], data[2]));
 
     let pixels565 = pixels888.map(pixelcolor::Rgb565::from);
-    let name565 = format!("{}_565", name);
+    let name565 = format!("{name}_565");
     std::fs::write(
         dir.join(&name565),
         pixels565
diff --git a/examples/smp_rp_pico/src/core0.rs b/examples/smp_rp_pico/src/core0.rs
@@ -32,7 +32,7 @@ impl support_rp2040::usbstdio::Options for SystemTraits {
 
         // echo the input with brackets
         if let Ok(s) = core::str::from_utf8(s) {
-            support_rp2040::sprint!("[{}]", s);
+            support_rp2040::sprint!("[{s}]");
         } else {
             support_rp2040::sprint!("[<not UTF-8>]");
         }
@@ -137,7 +137,7 @@ const fn configure_app(b: &mut r3_kernel::Cfg<SystemTraits>) -> Objects {
 }
 
 fn task1_body() {
-    support_rp2040::sprintln!("COTTAGE = {:?}", COTTAGE);
+    support_rp2040::sprintln!("COTTAGE = {COTTAGE:?}");
 
     COTTAGE.task2.activate().unwrap();
 }
diff --git a/examples/smp_rp_pico/src/panic_serial.rs b/examples/smp_rp_pico/src/panic_serial.rs
@@ -13,15 +13,15 @@ fn panic(info: &PanicInfo) -> ! {
 
     match cpuid {
         0 => {
-            r3_support_rp2040::sprintln!("{}", info);
+            r3_support_rp2040::sprintln!("{info}");
 
             loop {
                 r3_support_rp2040::usbstdio::poll::<crate::core0::SystemTraits>();
             }
         }
         1 => {
             use crate::core1;
-            core1::write_fmt(core1::Core1::new(&p.SIO).unwrap(), format_args!("{}", info));
+            core1::write_fmt(core1::Core1::new(&p.SIO).unwrap(), format_args!("{info}"));
 
             // Halt the system
             loop {
diff --git a/src/r3_kernel/src/utils/intrusive_list.rs b/src/r3_kernel/src/utils/intrusive_list.rs
@@ -753,7 +753,7 @@ fn basic_cell_static() {
     let ptr3 = push_static(El(3, Cell::new(None)));
     get_accessor!().push_front(ptr3).unwrap();
 
-    println!("{:?}", &head);
+    println!("{head:?}");
 
     let mut accessor = get_accessor!();
     assert!(!accessor.is_empty());
@@ -777,11 +777,11 @@ fn basic_cell_static() {
     assert_eq!(accessor.prev(ptr2).unwrap(), Some(ptr1));
 
     accessor.remove(ptr1).unwrap();
-    println!("{:?}", &head);
+    println!("{head:?}");
     accessor.remove(ptr2).unwrap();
-    println!("{:?}", &head);
+    println!("{head:?}");
     accessor.remove(ptr3).unwrap();
-    println!("{:?}", &head);
+    println!("{head:?}");
 
     assert!(accessor.is_empty());
 }
diff --git a/src/r3_kernel/src/wait.rs b/src/r3_kernel/src/wait.rs
@@ -568,7 +568,7 @@ impl<Traits: KernelTraits> fmt::Debug for WaitPayload<Traits> {
                 .field("orig_bits", orig_bits)
                 .finish(),
             Self::Semaphore => f.write_str("Semaphore"),
-            Self::Mutex(mutex) => write!(f, "Mutex({:p})", mutex),
+            Self::Mutex(mutex) => write!(f, "Mutex({mutex:p})"),
             Self::Park => f.write_str("Park"),
             Self::Sleep => f.write_str("Sleep"),
             Self::__Nonexhaustive => unreachable!(),
diff --git a/src/r3_port_arm_m_test_driver/build.rs b/src/r3_port_arm_m_test_driver/build.rs
@@ -3,7 +3,7 @@ use std::env;
 fn main() {
     println!("cargo:rerun-if-env-changed=R3_TEST_DRIVER_LINK_SEARCH");
     if let Ok(link_search) = env::var("R3_TEST_DRIVER_LINK_SEARCH") {
-        println!("cargo:rustc-link-search={}", link_search);
+        println!("cargo:rustc-link-search={link_search}");
     }
 
     // Use the linker script `device.x` at the crate root
diff --git a/src/r3_port_arm_m_test_driver/src/board_rp2040.rs b/src/r3_port_arm_m_test_driver/src/board_rp2040.rs
@@ -22,7 +22,7 @@ fn panic(info: &PanicInfo) -> ! {
     // Disable IRQ
     cortex_m::interrupt::disable();
 
-    r3_support_rp2040::sprintln!("{}{}", mux::BEGIN_MAIN, info);
+    r3_support_rp2040::sprintln!("{}{info}", mux::BEGIN_MAIN);
 
     enter_poll_loop();
 }
diff --git a/src/r3_port_arm_test_driver/build.rs b/src/r3_port_arm_test_driver/build.rs
@@ -3,6 +3,6 @@ use std::env;
 fn main() {
     println!("cargo:rerun-if-env-changed=R3_TEST_DRIVER_LINK_SEARCH");
     if let Ok(link_search) = env::var("R3_TEST_DRIVER_LINK_SEARCH") {
-        println!("cargo:rustc-link-search={}", link_search);
+        println!("cargo:rustc-link-search={link_search}");
     }
 }
diff --git a/src/r3_port_arm_test_driver/src/panic_semihosting.rs b/src/r3_port_arm_test_driver/src/panic_semihosting.rs
@@ -21,9 +21,9 @@ fn panic(info: &PanicInfo) -> ! {
         // with a single semihosting call.
         let buffer = unsafe { &mut BUFFER };
         buffer.clear();
-        let _ = writeln!(buffer, "{}", info);
+        let _ = writeln!(buffer, "{info}");
 
-        let _ = write!(hstdout, "{}", buffer);
+        let _ = write!(hstdout, "{buffer}");
     }
     debug::exit(EXIT_FAILURE);
 
diff --git a/src/r3_port_riscv_test_driver/build.rs b/src/r3_port_riscv_test_driver/build.rs
@@ -6,7 +6,7 @@ fn main() {
 
     println!("cargo:rerun-if-env-changed=R3_TEST_DRIVER_LINK_SEARCH");
     if let Ok(link_search) = env::var("R3_TEST_DRIVER_LINK_SEARCH") {
-        println!("cargo:rustc-link-search={}", link_search);
+        println!("cargo:rustc-link-search={link_search}");
     }
 
     let mut generated_code = String::new();
diff --git a/src/r3_port_riscv_test_driver/src/panic_uart.rs b/src/r3_port_riscv_test_driver/src/panic_uart.rs
@@ -5,7 +5,7 @@ fn panic(info: &PanicInfo) -> ! {
     // Disable interrupts
     unsafe { riscv::register::mstatus::clear_mie() };
 
-    crate::uart::stdout_write_fmt(format_args!("{}\n", info));
+    crate::uart::stdout_write_fmt(format_args!("{info}\n"));
 
     loop {}
 }
diff --git a/src/r3_test_runner/src/driverinterface.rs b/src/r3_test_runner/src/driverinterface.rs
@@ -214,19 +214,19 @@ impl TestDriver {
             );
         }
 
-        write!(rustflags, " {}", additional_rustflags).unwrap();
+        write!(rustflags, " {additional_rustflags}").unwrap();
 
         for name in linker_scripts.inputs.iter() {
-            write!(rustflags, " -C link-arg=-T{}", name).unwrap();
+            write!(rustflags, " -C link-arg=-T{name}").unwrap();
         }
 
         let target_features = &target_arch_opt.target_features;
-        log::debug!("target_features = {:?}", target_features);
+        log::debug!("target_features = {target_features:?}");
         if !target_features.is_empty() {
-            write!(rustflags, " -C target-feature={}", target_features).unwrap();
+            write!(rustflags, " -C target-feature={target_features}").unwrap();
         };
 
-        log::debug!("rustflags = {:?}", rustflags);
+        log::debug!("rustflags = {rustflags:?}");
 
         Ok(Self {
             rustflags,
@@ -342,7 +342,7 @@ impl TestDriver {
                     target
                         .cargo_features()
                         .iter()
-                        .map(|f| format!("--features={}", f)),
+                        .map(|f| format!("--features={f}")),
                 )
                 .args(if test_run.cpu_lock_by_basepri {
                     Some("--features=cpu-lock-by-basepri")
diff --git a/src/r3_test_runner/src/main.rs b/src/r3_test_runner/src/main.rs
@@ -129,7 +129,7 @@ async fn main_inner() -> anyhow::Result<()> {
     if opt.help_targets {
         println!("Supported targets:");
         for (name, target) in targets::TARGETS {
-            println!("  {:30}{}", name, target.target_arch());
+            println!("  {name:30}{}", target.target_arch());
         }
         return Ok(());
     }
diff --git a/src/r3_test_runner/src/selection.rs b/src/r3_test_runner/src/selection.rs
@@ -44,9 +44,9 @@ impl fmt::Display for TestRun<'_> {
 impl fmt::Display for TestCase<'_> {
     fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
         match self {
-            Self::KernelTest(name) => write!(f, "kernel_tests::{}", name),
-            Self::DriverKernelTest(name) => write!(f, "kernel_tests::{}", name),
-            Self::KernelBenchmark(name) => write!(f, "kernel_benchmarks::{}", name),
+            Self::KernelTest(name) => write!(f, "kernel_tests::{name}"),
+            Self::DriverKernelTest(name) => write!(f, "kernel_tests::{name}"),
+            Self::KernelBenchmark(name) => write!(f, "kernel_benchmarks::{name}"),
         }
     }
 }
diff --git a/src/r3_test_runner/src/subprocess.rs b/src/r3_test_runner/src/subprocess.rs
@@ -284,12 +284,12 @@ impl fmt::Display for ShellEscape<'_> {
                         break;
                     }
                 }
-                write!(f, "{}\"", utf8)
+                write!(f, "{utf8}\"")
             } else if bytes.iter().any(|b| special_chars.contains(b)) {
                 // Enclose in single quotes
-                write!(f, "'{}'", utf8)
+                write!(f, "'{utf8}'")
             } else {
-                write!(f, "{}", utf8)
+                write!(f, "{utf8}")
             }
         } else {
             // Some bytes are unprintable.
diff --git a/src/r3_test_runner/src/targets/jlink.rs b/src/r3_test_runner/src/targets/jlink.rs
@@ -100,7 +100,7 @@ impl DebugProbe for Fe310JLinkDebugProbe {
             let tempdir = TempDir::new("r3_test_runner").map_err(RunError::CreateTempDir)?;
             let section_files: Vec<_> = (0..regions.len())
                 .map(|i| {
-                    let name = format!("{}.bin", i);
+                    let name = format!("{i}.bin");
                     tempdir.path().join(&name)
                 })
                 .collect();
diff --git a/src/r3_test_runner/src/targets/openocd.rs b/src/r3_test_runner/src/targets/openocd.rs
@@ -119,12 +119,10 @@ impl DebugProbe for GrPeachOpenOcdDebugProbe {
             tokio::fs::write(
                 &cmd_file,
                 format!(
-                    "{}
-                    {}
+                    "{GR_PEACH_INIT}
+                    {GR_PEACH_RESET}
                     load_image \"{}\"
                     shutdown",
-                    GR_PEACH_INIT,
-                    GR_PEACH_RESET,
                     exe.display(),
                 ),
             )
@@ -143,10 +141,9 @@ impl DebugProbe for GrPeachOpenOcdDebugProbe {
             tokio::fs::write(
                 &cmd_file,
                 format!(
-                    "{}
+                    "{GR_PEACH_INIT}
                     arm semihosting enable
-                    resume 0x{:x}",
-                    GR_PEACH_INIT, entry,
+                    resume {entry:#x}",
                 ),
             )
             .await
diff --git a/src/r3_test_runner/src/targets/rp_pico.rs b/src/r3_test_runner/src/targets/rp_pico.rs
@@ -371,10 +371,7 @@ fn open_picoboot() -> Result<PicobootInterface> {
     // Locate the USB PICOBOOT interface
     log::debug!("Looking for the USB PICOBOOT interface");
     let config_desc = device.active_config_descriptor().with_context(|| {
-        format!(
-            "Failed to get the active config descriptor of the device '{:?}'.",
-            device
-        )
+        format!("Failed to get the active config descriptor of the device '{device:?}'.")
     })?;
     let interface = config_desc
         .interfaces()
@@ -438,16 +435,13 @@ fn open_picoboot() -> Result<PicobootInterface> {
     // Open the device
     let mut device_handle = device
         .open()
-        .with_context(|| format!("Failed to open the device '{:?}'.", device))?;
+        .with_context(|| format!("Failed to open the device '{device:?}'."))?;
 
     // Claim the interface
     device_handle
         .claim_interface(interface_i)
         .with_context(|| {
-            format!(
-                "Failed to claim the PICOBOOT interface (number {}).",
-                interface_i
-            )
+            format!("Failed to claim the PICOBOOT interface (number {interface_i}).")
         })?;
 
     // Reset the PICOBOOT interface
@@ -461,12 +455,7 @@ fn open_picoboot() -> Result<PicobootInterface> {
     log::debug!("Sending INTERFACE_RESET");
     device_handle
         .write_control(0x41, 0x41, 0x0000, interface_i as u16, &[], DEFAULE_TIMEOUT)
-        .with_context(|| {
-            format!(
-                "Failed to send INTERFACE_RESET to the device '{:?}'.",
-                device
-            )
-        })?;
+        .with_context(|| format!("Failed to send INTERFACE_RESET to the device '{device:?}'."))?;
 
     Ok(PicobootInterface {
         device_handle,
diff --git a/src/r3_test_runner/src/utils.rs b/src/r3_test_runner/src/utils.rs
@@ -10,10 +10,10 @@ where
     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
         let mut it = self.0.clone().into_iter();
         if let Some(e) = it.next() {
-            write!(f, "{}", e)?;
+            write!(f, "{e}")?;
             drop(e);
             for e in it {
-                write!(f, ",{}", e)?;
+                write!(f, ",{e}")?;
             }
         }
         Ok(())
@@ -29,10 +29,10 @@ where
     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
         let mut it = self.0.clone().into_iter();
         if let Some(e) = it.next() {
-            write!(f, "{}", e)?;
+            write!(f, "{e}")?;
             drop(e);
             for e in it {
-                write!(f, ", {}", e)?;
+                write!(f, ", {e}")?;
             }
         }
         Ok(())
diff --git a/src/r3_test_suite/build.rs b/src/r3_test_suite/build.rs

Original file line number	Diff line number	Diff line change
`@@ -99,7 +99,7 @@ const fn configure_app(b: &mut r3_kernel::Cfg<SystemTraits>) -> Objects {`
`99`	`99`	`}`
`100`	`100`
`101`	`101`	`fn task1_body() {`
`102`		`- support_rza1::sprintln!("COTTAGE = {:?}", COTTAGE);`
	`102`	`+ support_rza1::sprintln!("COTTAGE = {COTTAGE:?}");`
`103`	`103`
`104`	`104`	`COTTAGE.task2.activate().unwrap();`
`105`	`105`	`}`
Original file line number	Diff line number	Diff line change
`@@ -8,7 +8,7 @@ fn panic(info: &PanicInfo) -> ! {`
`8`	`8`	`// Disable IRQ`
`9`	`9`	`unsafe { asm!("cpsid i") };`
`10`	`10`
`11`		`- sprintln!("{}", info);`
	`11`	`+ sprintln!("{info}");`
`12`	`12`
`13`	`13`	`loop {}`
`14`	`14`	`}`
Original file line number	Diff line number	Diff line change
`@@ -72,7 +72,7 @@ const fn configure_app(b: &mut r3_kernel::Cfg<SystemTraits>) -> Objects {`
`72`	`72`	`}`
`73`	`73`
`74`	`74`	`fn task1_body() {`
`75`		`- rtt_target::rprintln!("COTTAGE = {:?}", COTTAGE);`
	`75`	`+ rtt_target::rprintln!("COTTAGE = {COTTAGE:?}");`
`76`	`76`
`77`	`77`	`COTTAGE.task2.activate().unwrap();`
`78`	`78`	`}`
Original file line number	Diff line number	Diff line change
`@@ -52,7 +52,7 @@ impl support_rp2040::usbstdio::Options for SystemTraits {`
`52`	`52`
`53`	`53`	`// echo the input with brackets`
`54`	`54`	`if let Ok(s) = core::str::from_utf8(s) {`
`55`		`- support_rp2040::sprint!("[{}]", s);`
	`55`	`+ support_rp2040::sprint!("[{s}]");`
`56`	`56`	`} else {`
`57`	`57`	`support_rp2040::sprint!("[<not UTF-8>]");`
`58`	`58`	`}`
`@@ -152,7 +152,7 @@ const fn configure_app(b: &mut r3_kernel::Cfg<SystemTraits>) -> Objects {`
`152`	`152`	`}`
`153`	`153`
`154`	`154`	`fn task1_body() {`
`155`		`- support_rp2040::sprintln!("COTTAGE = {:?}", COTTAGE);`
	`155`	`+ support_rp2040::sprintln!("COTTAGE = {COTTAGE:?}");`
`156`	`156`
`157`	`157`	`COTTAGE.task2.activate().unwrap();`
`158`	`158`	`}`
Original file line number	Diff line number	Diff line change
`@@ -7,7 +7,7 @@ fn panic(info: &PanicInfo) -> ! {`
`7`	`7`	`// Disable IRQ`
`8`	`8`	`unsafe { asm!("cpsid i") };`
`9`	`9`
`10`		`- r3_support_rp2040::sprintln!("{}", info);`
	`10`	`+ r3_support_rp2040::sprintln!("{info}");`
`11`	`11`
`12`	`12`	`loop {}`
`13`	`13`	`}`
Original file line number	Diff line number	Diff line change
`@@ -32,7 +32,7 @@ impl support_rp2040::usbstdio::Options for SystemTraits {`
`32`	`32`
`33`	`33`	`// echo the input with brackets`
`34`	`34`	`if let Ok(s) = core::str::from_utf8(s) {`
`35`		`- support_rp2040::sprint!("[{}]", s);`
	`35`	`+ support_rp2040::sprint!("[{s}]");`
`36`	`36`	`} else {`
`37`	`37`	`support_rp2040::sprint!("[<not UTF-8>]");`
`38`	`38`	`}`
`@@ -137,7 +137,7 @@ const fn configure_app(b: &mut r3_kernel::Cfg<SystemTraits>) -> Objects {`
`137`	`137`	`}`
`138`	`138`
`139`	`139`	`fn task1_body() {`
`140`		`- support_rp2040::sprintln!("COTTAGE = {:?}", COTTAGE);`
	`140`	`+ support_rp2040::sprintln!("COTTAGE = {COTTAGE:?}");`
`141`	`141`
`142`	`142`	`COTTAGE.task2.activate().unwrap();`
`143`	`143`	`}`