Refactor: make more modules private (#772)

* Move `command` module into `connection` module

* Make the `elf` and `error` modules private

* Don't document the modules/types behind the `cli` feature

* Clean up some imports

* Remove unused code

* Miscellaneous cleanup

* Update `CHANGELOG.md`

Author: jessebraham

CHANGELOG.md

@@ -8,16 +8,18 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ## [Unreleased]
 
 ### Added
+
 - Add `non-interactive` flag to `flash` subcommand (#737)
 - Add `no-reset` flag to `monitor` subcommands (#737)
 - Add an environment variable to set monitoring baudrate (`MONITOR_BAUD`) (#737)
-Add list-ports command to list available serial ports.
-- Add list-ports command to list available serial ports.
+- Add list-ports command to list available serial ports. (#761)
 
 ### Changed
+
 - Split the baudrate for connecting and monitorinig in `flash` subcommand (#737)
 - Normalized arguments of the CLI commands (#759)
 - `board-info` now prints `Security information`. (#758)
+- The `command`, `elf` and `error` modules are no longer public (#772)
 
 ### Fixed
 

cargo-espflash/src/main.rs

@@ -8,11 +8,11 @@ use cargo_metadata::{Message, MetadataCommand};
 use clap::{Args, CommandFactory, Parser, Subcommand};
 use espflash::{
     cli::{self, config::Config, monitor::monitor, *},
-    error::Error as EspflashError,
     flasher::parse_partition_table,
     logging::initialize_logger,
     targets::{Chip, XtalFrequency},
     update::check_for_update,
+    Error as EspflashError,
 };
 use log::{debug, info, LevelFilter};
 use miette::{IntoDiagnostic, Result, WrapErr};

espflash/Cargo.toml

@@ -15,7 +15,9 @@ bin-dir = "{ bin }{ binary-ext }"
 pkg-fmt = "zip"
 
 [package.metadata.docs.rs]
-rustdoc-args = ["--cfg", "docsrs"]
+features            = ["serialport"]
+no-default-features = true
+rustdoc-args        = ["--cfg", "docsrs"]
 
 [[bin]]
 name              = "espflash"
@@ -73,11 +75,10 @@ cli = [
     "dep:directories",
     "dep:env_logger",
     "dep:indicatif",
-    "dep:toml",
     "dep:update-informer",
     "miette/fancy",
     "serialport",
 ]
 
-# enables connecting to a device via serial port
+# Enables connecting to a device via serial port
 serialport = ["dep:regex", "dep:serialport", "dep:slip-codec", "dep:toml"]

espflash/src/bin/espflash.rs

@@ -7,11 +7,11 @@ use std::{
 use clap::{Args, CommandFactory, Parser, Subcommand};
 use espflash::{
     cli::{self, config::Config, monitor::monitor, *},
-    error::Error,
     flasher::parse_partition_table,
     logging::initialize_logger,
     targets::{Chip, XtalFrequency},
     update::check_for_update,
+    Error,
 };
 use log::{debug, info, LevelFilter};
 use miette::{IntoDiagnostic, Result, WrapErr};

espflash/src/cli/config.rs

@@ -19,7 +19,7 @@ use miette::{IntoDiagnostic, Result, WrapErr};
 use serde::{Deserialize, Serialize};
 use serialport::UsbPortInfo;
 
-use crate::{error::Error, flasher::FlashSettings};
+use crate::{flasher::FlashSettings, Error};
 
 /// A configured, known serial connection
 #[derive(Debug, Deserialize, Serialize, Default, Clone)]

espflash/src/cli/serial.rs

@@ -9,7 +9,7 @@ use serialport::{available_ports, SerialPortInfo, SerialPortType};
 
 use crate::{
     cli::{config::UsbDevice, Config, ConnectArgs},
-    error::Error,
+    Error,
 };
 
 /// Return the information of a serial port taking into account the different

espflash/src/command.rs espflash/src/connection/command.rsespflash/src/command.rs renamed to espflash/src/connection/command.rs

@@ -19,25 +19,24 @@ use slip_codec::SlipDecoder;
 #[cfg(unix)]
 use self::reset::UnixTightReset;
 use self::{
+    command::{Command, CommandType},
     encoder::SlipEncoder,
     reset::{
         construct_reset_strategy_sequence,
         hard_reset,
         reset_after_flash,
+        soft_reset,
         ClassicReset,
         ResetAfterOperation,
         ResetBeforeOperation,
         ResetStrategy,
         UsbJtagSerialReset,
     },
 };
-use crate::{
-    command::{Command, CommandType},
-    connection::reset::soft_reset,
-    error::{ConnectionError, Error, ResultExt, RomError, RomErrorKind},
-};
+use crate::error::{ConnectionError, Error, ResultExt, RomError, RomErrorKind};
 
-pub mod reset;
+pub(crate) mod command;
+pub(crate) mod reset;
 
 const MAX_CONNECT_ATTEMPTS: usize = 7;
 const MAX_SYNC_ATTEMPTS: usize = 5;
@@ -56,36 +55,36 @@ pub enum CommandResponseValue {
 }
 
 impl TryInto<u32> for CommandResponseValue {
-    type Error = crate::error::Error;
+    type Error = Error;
 
     fn try_into(self) -> Result<u32, Self::Error> {
         match self {
             CommandResponseValue::ValueU32(value) => Ok(value),
-            CommandResponseValue::ValueU128(_) => Err(crate::error::Error::InternalError),
-            CommandResponseValue::Vector(_) => Err(crate::error::Error::InternalError),
+            CommandResponseValue::ValueU128(_) => Err(Error::InternalError),
+            CommandResponseValue::Vector(_) => Err(Error::InternalError),
         }
     }
 }
 
 impl TryInto<u128> for CommandResponseValue {
-    type Error = crate::error::Error;
+    type Error = Error;
 
     fn try_into(self) -> Result<u128, Self::Error> {
         match self {
-            CommandResponseValue::ValueU32(_) => Err(crate::error::Error::InternalError),
+            CommandResponseValue::ValueU32(_) => Err(Error::InternalError),
             CommandResponseValue::ValueU128(value) => Ok(value),
-            CommandResponseValue::Vector(_) => Err(crate::error::Error::InternalError),
+            CommandResponseValue::Vector(_) => Err(Error::InternalError),
         }
     }
 }
 
 impl TryInto<Vec<u8>> for CommandResponseValue {
-    type Error = crate::error::Error;
+    type Error = Error;
 
     fn try_into(self) -> Result<Vec<u8>, Self::Error> {
         match self {
-            CommandResponseValue::ValueU32(_) => Err(crate::error::Error::InternalError),
-            CommandResponseValue::ValueU128(_) => Err(crate::error::Error::InternalError),
+            CommandResponseValue::ValueU32(_) => Err(Error::InternalError),
+            CommandResponseValue::ValueU128(_) => Err(Error::InternalError),
             CommandResponseValue::Vector(value) => Ok(value),
         }
     }

espflash/src/connection/mod.rs

@@ -1,4 +1,5 @@
-//! Most of this module is copied from `esptool.py` (https://github.com/espressif/esptool/blob/a8586d02b1305ebc687d31783437a7f4d4dbb70f/esptool/reset.py)
+// Most of this module is copied from `esptool.py`:
+// https://github.com/espressif/esptool/blob/a8586d0/esptool/reset.py
 
 #[cfg(unix)]
 use std::{io, os::fd::AsRawFd};
@@ -10,12 +11,13 @@ use log::debug;
 use serialport::SerialPort;
 use strum::{Display, EnumIter, EnumString, VariantNames};
 
-use crate::{
+use super::{
     command::{Command, CommandType},
-    connection::{Connection, Port, USB_SERIAL_JTAG_PID},
-    error::Error,
-    flasher::FLASH_WRITE_SIZE,
+    Connection,
+    Port,
+    USB_SERIAL_JTAG_PID,
 };
+use crate::{flasher::FLASH_WRITE_SIZE, Error};
 
 /// Default time to wait before releasing the boot pin after a reset
 const DEFAULT_RESET_DELAY: u64 = 50; // ms

espflash/src/connection/reset.rs

@@ -13,7 +13,7 @@ use thiserror::Error;
 #[cfg(feature = "cli")]
 use crate::cli::monitor::parser::esp_defmt::DefmtError;
 #[cfg(feature = "serialport")]
-use crate::command::CommandType;
+use crate::connection::command::CommandType;
 use crate::{
     flasher::{FlashFrequency, FlashSize},
     targets::Chip,