Show progress when skipping and verifying (#904)

* Show progress when skipping and verifying

The progress callbacks get initialized and updated even if we skip a
segment. For verification, we add an extra step to the progress which is
updated once verification is complete.

* Make callbacks compulsory, add empty impl convience struct

* changelog

* fixups

* Add skip bool to finish to determine whether the segment was finished via skip or real work was done

* more changelog

* Fix new clippy lints introduced in 1.88

---------

Co-authored-by: Jesse Braham <[email protected]>

Author: MabezDev

CHANGELOG.md

@@ -33,6 +33,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - All methods on the now removed `Target` & `ReadEFuse`, `UsbOtg` and `RtcWdtReset` traits have been implemented directly on (#891)
 - Update checks can now be skipped by setting the the `ESPFLASH_SKIP_UPDATE_CHECK` environment variable (#900)
 - `flash_write_size` and `max_ram_block_size` functions no longer take a connection parameter and return a Result type (#903)
+- `DefaultProgressCallback` which implements `ProgressCallbacks` but all methods are no-ops (#904)
 
 ### Changed
 
@@ -58,13 +59,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - `Flasher::into_serial` has been replaced by `Flasher::into_connection` (#882)
 - Automatically migrate `espflash@3` configuration files to the new format (#883)
 - Update dependencies to their latest versions (#893)
-- `ProgressCallbacks` has moved to `flasher` (#891)
 - `Chip::crystal_freq` has been renamed to `Chip::xtal_frequency` (#891)
 - `Chip::chip_revision` has been renamed to `Chip::revision` (also applies to `minor` and `major`) (#891)
 - Any reference to `esp_idf` or `EspIdf` has been cut to just `idf` (#891)
 - Renamed `targets` module to `target` (#891)
 - Test data is now excluded from the crates.io release (#897)
-- The command module, and `Command` related structs now exist in a top level module, instead of the `connection` module (#901) 
+- The command module, and `Command` related structs now exist in a top level module, instead of the `connection` module (#901)
+- API's that take `Option<&mut dyn ProgressCallbacks>` now take `&mut dyn ProgressCallbacks` instead (#904)
+- `ProgressCallbacks::finish()` now has a `skipped: bool` parameter to indicate if a segment was skipped (#904)
 
 ### Fixed
 
@@ -79,6 +81,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - espflash now extracts the MMU page size from the app descriptor (#835)
 - `ResetBeforeOperation` & `ResetAfterOperation` are now public, to allow the creation of a `Connection` (#895)
 - `Flasher` now respects its internal `verify` and `skip` flags for all methods. (#901)
+- Progress is now reported on skipped segments and verification (#904)
 
 ### Removed
 

cargo-espflash/src/main.rs

@@ -242,7 +242,7 @@ fn main() -> Result<()> {
         subcommand: args,
         skip_update_check,
     } = cli.subcommand;
-    debug!("{:#?}, {:#?}", args, skip_update_check);
+    debug!("{args:#?}, {skip_update_check:#?}");
 
     // Only check for updates once the command-line arguments have been processed,
     // to avoid printing any update notifications when the help message is
@@ -366,7 +366,7 @@ fn flash(args: FlashArgs, config: &Config) -> Result<()> {
         .or_else(|| Some(FlashSize::default())); // Otherwise, use a reasonable default value
 
     if args.flash_args.ram {
-        flasher.load_elf_to_ram(&elf_data, Some(&mut EspflashProgress::default()))?;
+        flasher.load_elf_to_ram(&elf_data, &mut EspflashProgress::default())?;
     } else {
         let flash_data = make_flash_data(
             args.flash_args.image,
@@ -581,7 +581,7 @@ fn build(
             }
             Message::CompilerMessage(message) => {
                 if let Some(rendered) = message.message.rendered {
-                    print!("{}", rendered);
+                    print!("{rendered}");
                 }
             }
             // Ignore all other messages.

espflash/src/bin/espflash.rs

@@ -279,7 +279,7 @@ fn flash(args: FlashArgs, config: &Config) -> Result<()> {
         .or_else(|| Some(FlashSize::default())); // Otherwise, use a reasonable default value
 
     if args.flash_args.ram {
-        flasher.load_elf_to_ram(&elf_data, Some(&mut EspflashProgress::default()))?;
+        flasher.load_elf_to_ram(&elf_data, &mut EspflashProgress::default())?;
     } else {
         let flash_data = make_flash_data(
             args.flash_args.image,

espflash/src/cli/config.rs

@@ -61,7 +61,7 @@ fn serialize_u16_to_hex<S>(decimal: &u16, serializer: S) -> Result<S::Ok, S::Err
 where
     S: serde::Serializer,
 {
-    let hex_string = format!("{:04x}", decimal);
+    let hex_string = format!("{decimal:04x}");
     serializer.serialize_str(&hex_string)
 }
 

espflash/src/cli/mod.rs

@@ -47,15 +47,14 @@ use crate::{
         FlashSettings,
         FlashSize,
         Flasher,
-        ProgressCallbacks,
     },
     image_format::{
         ImageFormat,
         ImageFormatKind,
         Metadata,
         idf::{IdfBootloaderFormat, parse_partition_table},
     },
-    target::{Chip, XtalFrequency},
+    target::{Chip, ProgressCallbacks, XtalFrequency},
 };
 
 pub mod config;
@@ -481,7 +480,7 @@ pub fn checksum_md5(args: &ChecksumMd5Args, config: &Config) -> Result<()> {
     let mut flasher = connect(&args.connect_args, config, true, true)?;
 
     let checksum = flasher.checksum_md5(args.address, args.size)?;
-    println!("0x{:x}", checksum);
+    println!("0x{checksum:x}");
 
     let chip = flasher.chip();
     flasher
@@ -620,7 +619,7 @@ pub fn print_board_info(flasher: &mut Flasher) -> Result<()> {
     println!("Features:          {}", info.features.join(", "));
 
     if let Some(mac) = info.mac_address {
-        println!("MAC address:       {}", mac);
+        println!("MAC address:       {mac}");
     }
 
     Ok(())
@@ -767,7 +766,7 @@ impl ProgressCallbacks for EspflashProgress {
     }
 
     /// End the progress bar
-    fn finish(&mut self) {
+    fn finish(&mut self, _skipped: bool) {
         if let Some(ref pb) = self.pb {
             pb.finish();
         }
@@ -827,7 +826,7 @@ pub fn erase_region(args: EraseRegionArgs, config: &Config) -> Result<()> {
 
 /// Write an ELF image to a target device's flash
 pub fn flash_image<'a>(flasher: &mut Flasher, image_format: ImageFormat<'a>) -> Result<()> {
-    flasher.load_image_to_flash(Some(&mut EspflashProgress::default()), image_format)?;
+    flasher.load_image_to_flash(&mut EspflashProgress::default(), image_format)?;
     info!("Flashing has completed!");
 
     Ok(())
@@ -1117,11 +1116,7 @@ pub fn write_bin(args: WriteBinArgs, config: &Config) -> Result<()> {
     let chip = flasher.chip();
     let target_xtal_freq = chip.xtal_frequency(flasher.connection())?;
 
-    flasher.write_bin_to_flash(
-        args.address,
-        &buffer,
-        Some(&mut EspflashProgress::default()),
-    )?;
+    flasher.write_bin_to_flash(args.address, &buffer, &mut EspflashProgress::default())?;
 
     if args.monitor {
         let pid = flasher.connection().usb_pid();

espflash/src/cli/monitor/mod.rs

@@ -67,7 +67,7 @@ impl RawModeGuard {
 impl Drop for RawModeGuard {
     fn drop(&mut self) {
         if let Err(e) = disable_raw_mode() {
-            error!("Failed to disable raw_mode: {:#}", e)
+            error!("Failed to disable raw_mode: {e:#}")
         }
     }
 }
@@ -90,7 +90,7 @@ pub fn monitor(
     }
 
     let baud = monitor_args.monitor_baud;
-    debug!("Opening serial monitor with baudrate: {}", baud);
+    debug!("Opening serial monitor with baudrate: {baud}");
 
     // Explicitly set the baud rate when starting the serial monitor, to allow using
     // different rates for flashing.

espflash/src/cli/monitor/parser/mod.rs

@@ -38,7 +38,7 @@ fn resolve_addresses(
         let location = symbols.location(addr);
 
         if let Some(name) = name {
-            let output = if line.trim() == format!("0x{:x}", addr) {
+            let output = if line.trim() == format!("0x{addr:x}") {
                 if let Some((file, line_num)) = location {
                     format!("{name}\r\n    at {file}:{line_num}\r\n")
                 } else {

espflash/src/cli/serial.rs

@@ -58,7 +58,7 @@ pub fn serial_port_info(matches: &ConnectArgs, config: &Config) -> Result<Serial
                             pid: usb_info.pid,
                         })
                     }) {
-                        error!("Failed to save config {:#}", e);
+                        error!("Failed to save config {e:#}");
                     }
                 }
             }
@@ -190,7 +190,7 @@ fn select_serial_port(
                 match &port_info.port_type {
                     SerialPortType::UsbPort(info) => {
                         if let Some(product) = &info.product {
-                            format!("{} - {}", formatted, product)
+                            format!("{formatted} - {product}")
                         } else {
                             formatted.to_string()
                         }
@@ -242,9 +242,9 @@ fn confirm_port(port_name: &str, product: Option<&String>) -> Result<bool, Error
     Confirm::with_theme(&ColorfulTheme::default())
         .with_prompt({
             if let Some(product) = product {
-                format!("Use serial port '{}' - {}?", port_name, product)
+                format!("Use serial port '{port_name}' - {product}?")
             } else {
-                format!("Use serial port '{}'?", port_name)
+                format!("Use serial port '{port_name}'?")
             }
         })
         .interact_opt()?

espflash/src/command.rs

@@ -152,8 +152,7 @@ impl CommandType {
             CommandType::FlashDeflEnd => FLASH_DEFLATE_END_TIMEOUT,
             CommandType::FlashMd5 => {
                 log::warn!(
-                    "Using default timeout for {}, this may not be sufficient for large flash regions. Consider using `timeout_for_size` instead.",
-                    self
+                    "Using default timeout for {self}, this may not be sufficient for large flash regions. Consider using `timeout_for_size` instead."
                 );
 
                 DEFAULT_TIMEOUT

espflash/src/connection/mod.rs

@@ -99,7 +99,7 @@ impl Connection {
                     return Ok(());
                 }
                 Err(e) => {
-                    debug!("Failed to reset, error {:#?}, retrying", e);
+                    debug!("Failed to reset, error {e:#?}, retrying");
                 }
             }
         }
@@ -159,8 +159,8 @@ impl Connection {
                 download_mode = data.get(2).is_some();
 
                 // Further processing or printing the results
-                debug!("Boot Mode: {}", boot_mode);
-                debug!("Download Mode: {}", download_mode);
+                debug!("Boot Mode: {boot_mode}");
+                debug!("Download Mode: {download_mode}");
             };
         }
 
@@ -447,7 +447,7 @@ impl Connection {
 
     /// Write a command to the serial port.
     pub fn write_command(&mut self, command: Command<'_>) -> Result<(), Error> {
-        debug!("Writing command: {:02x?}", command);
+        debug!("Writing command: {command:02x?}");
         let mut binding = Box::new(&mut self.serial);
         let serial = binding.as_mut();
 
@@ -575,7 +575,7 @@ impl Connection {
         } else {
             self.read_reg(CHIP_DETECT_MAGIC_REG_ADDR)?
         };
-        debug!("Read chip magic value: 0x{:08x}", magic);
+        debug!("Read chip magic value: 0x{magic:08x}");
         Chip::from_magic(magic)
     }
 }