Merge pull request #2787 from hi-rustin/rustin-patch-utils-cleanup

Make all utils functions and structs crate-private and cleanup unused functions

Author: rbtcollins

src/cli/common.rs

@@ -249,7 +249,7 @@ fn show_channel_updates(cfg: &Cfg, toolchains: Vec<(String, Result<UpdateStatus>
     Ok(())
 }
 
-pub fn update_all_channels(
+pub(crate) fn update_all_channels(
     cfg: &Cfg,
     do_self_update: bool,
     force_update: bool,
@@ -327,7 +327,7 @@ pub fn self_update_permitted(explicit: bool) -> Result<SelfUpdatePermission> {
     }
 }
 
-pub fn self_update<F>(before_restart: F) -> Result<utils::ExitCode>
+pub(crate) fn self_update<F>(before_restart: F) -> Result<utils::ExitCode>
 where
     F: FnOnce() -> Result<utils::ExitCode>,
 {
@@ -354,7 +354,7 @@ where
     Ok(utils::ExitCode(0))
 }
 
-pub fn list_targets(toolchain: &Toolchain<'_>) -> Result<utils::ExitCode> {
+pub(crate) fn list_targets(toolchain: &Toolchain<'_>) -> Result<utils::ExitCode> {
     let mut t = term2::stdout();
     let distributable = DistributableToolchain::new_for_components(&toolchain)?;
     let components = distributable.list_components()?;
@@ -378,7 +378,7 @@ pub fn list_targets(toolchain: &Toolchain<'_>) -> Result<utils::ExitCode> {
     Ok(utils::ExitCode(0))
 }
 
-pub fn list_installed_targets(toolchain: &Toolchain<'_>) -> Result<utils::ExitCode> {
+pub(crate) fn list_installed_targets(toolchain: &Toolchain<'_>) -> Result<utils::ExitCode> {
     let mut t = term2::stdout();
     let distributable = DistributableToolchain::new_for_components(&toolchain)?;
     let components = distributable.list_components()?;
@@ -397,7 +397,7 @@ pub fn list_installed_targets(toolchain: &Toolchain<'_>) -> Result<utils::ExitCo
     Ok(utils::ExitCode(0))
 }
 
-pub fn list_components(toolchain: &Toolchain<'_>) -> Result<utils::ExitCode> {
+pub(crate) fn list_components(toolchain: &Toolchain<'_>) -> Result<utils::ExitCode> {
     let mut t = term2::stdout();
     let distributable = DistributableToolchain::new_for_components(&toolchain)?;
     let components = distributable.list_components()?;
@@ -415,7 +415,7 @@ pub fn list_components(toolchain: &Toolchain<'_>) -> Result<utils::ExitCode> {
     Ok(utils::ExitCode(0))
 }
 
-pub fn list_installed_components(toolchain: &Toolchain<'_>) -> Result<utils::ExitCode> {
+pub(crate) fn list_installed_components(toolchain: &Toolchain<'_>) -> Result<utils::ExitCode> {
     let mut t = term2::stdout();
     let distributable = DistributableToolchain::new_for_components(&toolchain)?;
     let components = distributable.list_components()?;
@@ -460,7 +460,7 @@ fn print_toolchain_path(
     Ok(())
 }
 
-pub fn list_toolchains(cfg: &Cfg, verbose: bool) -> Result<utils::ExitCode> {
+pub(crate) fn list_toolchains(cfg: &Cfg, verbose: bool) -> Result<utils::ExitCode> {
     let toolchains = cfg.list_toolchains()?;
     if toolchains.is_empty() {
         writeln!(process().stdout(), "no installed toolchains")?;
@@ -495,7 +495,7 @@ pub fn list_toolchains(cfg: &Cfg, verbose: bool) -> Result<utils::ExitCode> {
     Ok(utils::ExitCode(0))
 }
 
-pub fn list_overrides(cfg: &Cfg) -> Result<utils::ExitCode> {
+pub(crate) fn list_overrides(cfg: &Cfg) -> Result<utils::ExitCode> {
     let overrides = cfg.settings_file.with(|s| Ok(s.overrides.clone()))?;
 
     if overrides.is_empty() {
@@ -538,7 +538,7 @@ pub fn version() -> &'static str {
     &RENDERED
 }
 
-pub fn dump_testament() -> Result<utils::ExitCode> {
+pub(crate) fn dump_testament() -> Result<utils::ExitCode> {
     use git_testament::GitModification::*;
     writeln!(
         process().stdout(),

src/cli/download_tracker.rs

@@ -73,7 +73,7 @@ impl DownloadTracker {
         self
     }
 
-    pub fn handle_notification(&mut self, n: &Notification<'_>) -> bool {
+    pub(crate) fn handle_notification(&mut self, n: &Notification<'_>) -> bool {
         match *n {
             Notification::Install(In::Utils(Un::DownloadContentLengthReceived(content_len))) => {
                 self.content_length_received(content_len);
@@ -219,7 +219,7 @@ impl DownloadTracker {
         }
     }
 
-    pub fn push_unit(&mut self, new_unit: Unit) {
+    pub(crate) fn push_unit(&mut self, new_unit: Unit) {
         self.units.push(new_unit);
     }
 

src/cli/self_update.rs

@@ -70,7 +70,7 @@ use crate::utils::Notification;
 use crate::{Cfg, UpdateStatus};
 use crate::{DUP_TOOLS, TOOLS};
 use os::*;
-pub use os::{delete_rustup_and_cargo_home, run_update, self_replace};
+pub(crate) use os::{delete_rustup_and_cargo_home, run_update, self_replace};
 #[cfg(windows)]
 pub use windows::complete_windows_uninstall;
 
@@ -324,7 +324,7 @@ fn canonical_cargo_home() -> Result<Cow<'static, str>> {
 /// Installing is a simple matter of copying the running binary to
 /// `CARGO_HOME`/bin, hard-linking the various Rust tools to it,
 /// and adding `CARGO_HOME`/bin to PATH.
-pub fn install(
+pub(crate) fn install(
     no_prompt: bool,
     verbose: bool,
     quiet: bool,
@@ -862,7 +862,7 @@ fn _install_selection<'a>(
     })
 }
 
-pub fn uninstall(no_prompt: bool) -> Result<utils::ExitCode> {
+pub(crate) fn uninstall(no_prompt: bool) -> Result<utils::ExitCode> {
     if NEVER_SELF_UPDATE {
         err!("self-uninstall is disabled for this build of rustup");
         err!("you should probably use your system package manager to uninstall rustup");
@@ -978,7 +978,7 @@ pub fn uninstall(no_prompt: bool) -> Result<utils::ExitCode> {
 /// (and on windows this process will not be running to do it),
 /// rustup-init is stored in `CARGO_HOME`/bin, and then deleted next
 /// time rustup runs.
-pub fn update(cfg: &Cfg) -> Result<utils::ExitCode> {
+pub(crate) fn update(cfg: &Cfg) -> Result<utils::ExitCode> {
     use common::SelfUpdatePermission::*;
     let update_permitted = if NEVER_SELF_UPDATE {
         HardFail

src/cli/self_update/unix.rs

@@ -12,7 +12,7 @@ use crate::utils::Notification;
 // If the user is trying to install with sudo, on some systems this will
 // result in writing root-owned files to the user's home directory, because
 // sudo is configured not to change $HOME. Don't let that bogosity happen.
-pub fn do_anti_sudo_check(no_prompt: bool) -> Result<utils::ExitCode> {
+pub(crate) fn do_anti_sudo_check(no_prompt: bool) -> Result<utils::ExitCode> {
     pub fn home_mismatch() -> (bool, PathBuf, PathBuf) {
         let fallback = || (false, PathBuf::new(), PathBuf::new());
         // test runner should set this, nothing else
@@ -126,7 +126,7 @@ pub fn do_remove_from_programs() -> Result<()> {
 
 /// Tell the upgrader to replace the rustup bins, then delete
 /// itself.
-pub fn run_update(setup_path: &Path) -> Result<utils::ExitCode> {
+pub(crate) fn run_update(setup_path: &Path) -> Result<utils::ExitCode> {
     let status = Command::new(setup_path)
         .arg("--self-replace")
         .status()
@@ -142,7 +142,7 @@ pub fn run_update(setup_path: &Path) -> Result<utils::ExitCode> {
 /// This function is as the final step of a self-upgrade. It replaces
 /// `CARGO_HOME`/bin/rustup with the running exe, and updates the the
 /// links to it.
-pub fn self_replace() -> Result<utils::ExitCode> {
+pub(crate) fn self_replace() -> Result<utils::ExitCode> {
     install_bins()?;
 
     Ok(utils::ExitCode(0))

src/command.rs

@@ -7,7 +7,7 @@ use anyhow::{Context, Result};
 use crate::errors::*;
 use crate::utils::utils::ExitCode;
 
-pub fn run_command_for_dir<S: AsRef<OsStr>>(
+pub(crate) fn run_command_for_dir<S: AsRef<OsStr>>(
     mut cmd: Command,
     arg0: &str,
     args: &[S],

src/config.rs

@@ -246,7 +246,7 @@ pub struct Cfg {
 }
 
 impl Cfg {
-    pub fn from_env(notify_handler: Arc<dyn Fn(Notification<'_>)>) -> Result<Self> {
+    pub(crate) fn from_env(notify_handler: Arc<dyn Fn(Notification<'_>)>) -> Result<Self> {
         // Set up the rustup home directory
         let rustup_dir = utils::rustup_home()?;
 
@@ -359,7 +359,7 @@ impl Cfg {
     }
 
     /// construct a download configuration
-    pub fn download_cfg<'a>(
+    pub(crate) fn download_cfg<'a>(
         &'a self,
         notify_handler: &'a dyn Fn(crate::dist::Notification<'_>),
     ) -> DownloadCfg<'a> {

src/dist/component/package.rs

@@ -139,7 +139,7 @@ impl Package for DirectoryPackage {
 pub struct TarPackage<'a>(DirectoryPackage, temp::Dir<'a>);
 
 impl<'a> TarPackage<'a> {
-    pub fn new<R: Read>(
+    pub(crate) fn new<R: Read>(
         stream: R,
         temp_cfg: &'a temp::Cfg,
         notify_handler: Option<&'a dyn Fn(Notification<'_>)>,
@@ -551,7 +551,7 @@ impl<'a> Package for TarPackage<'a> {
 pub struct TarGzPackage<'a>(TarPackage<'a>);
 
 impl<'a> TarGzPackage<'a> {
-    pub fn new<R: Read>(
+    pub(crate) fn new<R: Read>(
         stream: R,
         temp_cfg: &'a temp::Cfg,
         notify_handler: Option<&'a dyn Fn(Notification<'_>)>,
@@ -587,7 +587,7 @@ impl<'a> Package for TarGzPackage<'a> {
 pub struct TarXzPackage<'a>(TarPackage<'a>);
 
 impl<'a> TarXzPackage<'a> {
-    pub fn new<R: Read>(
+    pub(crate) fn new<R: Read>(
         stream: R,
         temp_cfg: &'a temp::Cfg,
         notify_handler: Option<&'a dyn Fn(Notification<'_>)>,
@@ -623,7 +623,7 @@ impl<'a> Package for TarXzPackage<'a> {
 pub struct TarZStdPackage<'a>(TarPackage<'a>);
 
 impl<'a> TarZStdPackage<'a> {
-    pub fn new<R: Read>(
+    pub(crate) fn new<R: Read>(
         stream: R,
         temp_cfg: &'a temp::Cfg,
         notify_handler: Option<&'a dyn Fn(Notification<'_>)>,

src/dist/component/transaction.rs

@@ -168,7 +168,7 @@ impl<'a> Transaction<'a> {
     pub fn temp(&self) -> &'a temp::Cfg {
         self.temp_cfg
     }
-    pub fn notify_handler(&self) -> &'a dyn Fn(Notification<'_>) {
+    pub(crate) fn notify_handler(&self) -> &'a dyn Fn(Notification<'_>) {
         self.notify_handler
     }
 }

src/dist/manifestation.rs

@@ -379,7 +379,7 @@ impl Manifestation {
     }
 
     /// Installation using the legacy v1 manifest format
-    pub fn update_v1(
+    pub(crate) fn update_v1(
         &self,
         new_manifest: &[String],
         update_hash: Option<&Path>,

src/dist/notifications.rs

@@ -54,7 +54,7 @@ impl<'a> From<temp::Notification<'a>> for Notification<'a> {
 }
 
 impl<'a> Notification<'a> {
-    pub fn level(&self) -> NotificationLevel {
+    pub(crate) fn level(&self) -> NotificationLevel {
         use self::Notification::*;
         match self {
             Temp(n) => n.level(),