Merge pull request #2829 from hi-rustin/rustin-patch-cli

Make all cli functions and structs crate-private

Author: rbtcollins

src/cli/common.rs

@@ -21,9 +21,9 @@ use crate::utils::notify::NotificationLevel;
 use crate::utils::utils;
 use crate::{Cfg, Notification, Toolchain, UpdateStatus};
 
-pub const WARN_COMPLETE_PROFILE: &str = "downloading with complete profile isn't recommended unless you are a developer of the rust language";
+pub(crate) const WARN_COMPLETE_PROFILE: &str = "downloading with complete profile isn't recommended unless you are a developer of the rust language";
 
-pub fn confirm(question: &str, default: bool) -> Result<bool> {
+pub(crate) fn confirm(question: &str, default: bool) -> Result<bool> {
     write!(process().stdout(), "{} ", question)?;
     let _ = std::io::stdout().flush();
     let input = read_line()?;
@@ -40,13 +40,13 @@ pub fn confirm(question: &str, default: bool) -> Result<bool> {
     Ok(r)
 }
 
-pub enum Confirm {
+pub(crate) enum Confirm {
     Yes,
     No,
     Advanced,
 }
 
-pub fn confirm_advanced() -> Result<Confirm> {
+pub(crate) fn confirm_advanced() -> Result<Confirm> {
     writeln!(process().stdout())?;
     writeln!(process().stdout(), "1) Proceed with installation (default)")?;
     writeln!(process().stdout(), "2) Customize installation")?;
@@ -67,7 +67,7 @@ pub fn confirm_advanced() -> Result<Confirm> {
     Ok(r)
 }
 
-pub fn question_str(question: &str, default: &str) -> Result<String> {
+pub(crate) fn question_str(question: &str, default: &str) -> Result<String> {
     writeln!(process().stdout(), "{} [{}]", question, default)?;
     let _ = std::io::stdout().flush();
     let input = read_line()?;
@@ -81,7 +81,7 @@ pub fn question_str(question: &str, default: &str) -> Result<String> {
     }
 }
 
-pub fn question_bool(question: &str, default: bool) -> Result<bool> {
+pub(crate) fn question_bool(question: &str, default: bool) -> Result<bool> {
     let default_text = if default { "(Y/n)" } else { "(y/N)" };
     writeln!(process().stdout(), "{} {}", question, default_text)?;
 
@@ -101,7 +101,7 @@ pub fn question_bool(question: &str, default: bool) -> Result<bool> {
     }
 }
 
-pub fn read_line() -> Result<String> {
+pub(crate) fn read_line() -> Result<String> {
     let stdin = process().stdin();
     let stdin = stdin.lock();
     let mut lines = stdin.lines();
@@ -156,7 +156,7 @@ impl NotifyOnConsole {
     }
 }
 
-pub fn set_globals(verbose: bool, quiet: bool) -> Result<Cfg> {
+pub(crate) fn set_globals(verbose: bool, quiet: bool) -> Result<Cfg> {
     use std::cell::RefCell;
 
     use super::download_tracker::DownloadTracker;
@@ -175,7 +175,11 @@ pub fn set_globals(verbose: bool, quiet: bool) -> Result<Cfg> {
     }))
 }
 
-pub fn show_channel_update(cfg: &Cfg, name: &str, updated: Result<UpdateStatus>) -> Result<()> {
+pub(crate) fn show_channel_update(
+    cfg: &Cfg,
+    name: &str,
+    updated: Result<UpdateStatus>,
+) -> Result<()> {
     show_channel_updates(cfg, vec![(name.to_string(), updated)])
 }
 
@@ -277,13 +281,13 @@ pub(crate) fn update_all_channels(
 }
 
 #[derive(Clone, Copy, Debug)]
-pub enum SelfUpdatePermission {
+pub(crate) enum SelfUpdatePermission {
     HardFail,
     Skip,
     Permit,
 }
 
-pub fn self_update_permitted(explicit: bool) -> Result<SelfUpdatePermission> {
+pub(crate) fn self_update_permitted(explicit: bool) -> Result<SelfUpdatePermission> {
     if cfg!(windows) {
         Ok(SelfUpdatePermission::Permit)
     } else {
@@ -528,7 +532,7 @@ pub(crate) fn list_overrides(cfg: &Cfg) -> Result<utils::ExitCode> {
 
 git_testament!(TESTAMENT);
 
-pub fn version() -> &'static str {
+pub(crate) fn version() -> &'static str {
     lazy_static! {
         // Because we trust our `stable` branch given the careful release
         // process, we mark it trusted here so that our version numbers look
@@ -618,7 +622,7 @@ pub fn report_error(e: &anyhow::Error) {
     }
 }
 
-pub fn ignorable_error(error: &'static str, no_prompt: bool) -> Result<()> {
+pub(crate) fn ignorable_error(error: &'static str, no_prompt: bool) -> Result<()> {
     let error = anyhow!(error);
     report_error(&error);
     if no_prompt {

src/cli/download_tracker.rs

@@ -16,7 +16,7 @@ use crate::Notification;
 const DOWNLOAD_TRACK_COUNT: usize = 5;
 
 /// Tracks download progress and displays information about it to a terminal.
-pub struct DownloadTracker {
+pub(crate) struct DownloadTracker {
     /// Content-Length of the to-be downloaded object.
     content_len: Option<usize>,
     /// Total data downloaded in bytes.
@@ -53,7 +53,7 @@ pub struct DownloadTracker {
 
 impl DownloadTracker {
     /// Creates a new DownloadTracker.
-    pub fn new() -> Self {
+    pub(crate) fn new() -> Self {
         Self {
             content_len: None,
             total_downloaded: 0,
@@ -68,7 +68,7 @@ impl DownloadTracker {
         }
     }
 
-    pub fn with_display_progress(mut self, display_progress: bool) -> Self {
+    pub(crate) fn with_display_progress(mut self, display_progress: bool) -> Self {
         self.display_progress = display_progress;
         self
     }
@@ -104,12 +104,12 @@ impl DownloadTracker {
     }
 
     /// Notifies self that Content-Length information has been received.
-    pub fn content_length_received(&mut self, content_len: u64) {
+    pub(crate) fn content_length_received(&mut self, content_len: u64) {
         self.content_len = Some(content_len as usize);
     }
 
     /// Notifies self that data of size `len` has been received.
-    pub fn data_received(&mut self, len: usize) {
+    pub(crate) fn data_received(&mut self, len: usize) {
         self.total_downloaded += len;
         self.downloaded_this_sec += len;
 
@@ -135,7 +135,7 @@ impl DownloadTracker {
         }
     }
     /// Notifies self that the download has finished.
-    pub fn download_finished(&mut self) {
+    pub(crate) fn download_finished(&mut self) {
         if self.displayed_charcount.is_some() {
             // Display the finished state
             self.display();
@@ -223,7 +223,7 @@ impl DownloadTracker {
         self.units.push(new_unit);
     }
 
-    pub fn pop_unit(&mut self) {
+    pub(crate) fn pop_unit(&mut self) {
         self.units.pop();
     }
 }

src/cli/help.rs

@@ -1,4 +1,4 @@
-pub static RUSTUP_HELP: &str = r"DISCUSSION:
+pub(crate) static RUSTUP_HELP: &str = r"DISCUSSION:
     Rustup installs The Rust Programming Language from the official
     release channels, enabling you to easily switch between stable,
     beta, and nightly compilers and keep them updated. It makes
@@ -8,7 +8,7 @@ pub static RUSTUP_HELP: &str = r"DISCUSSION:
     If you are new to Rust consider running `rustup doc --book` to
     learn Rust.";
 
-pub static SHOW_HELP: &str = r"DISCUSSION:
+pub(crate) static SHOW_HELP: &str = r"DISCUSSION:
     Shows the name of the active toolchain and the version of `rustc`.
 
     If the active toolchain has installed support for additional
@@ -17,7 +17,7 @@ pub static SHOW_HELP: &str = r"DISCUSSION:
     If there are multiple toolchains installed then all installed
     toolchains are listed as well.";
 
-pub static SHOW_ACTIVE_TOOLCHAIN_HELP: &str = r"DISCUSSION:
+pub(crate) static SHOW_ACTIVE_TOOLCHAIN_HELP: &str = r"DISCUSSION:
     Shows the name of the active toolchain.
 
     This is useful for figuring out the active tool chain from
@@ -26,24 +26,24 @@ pub static SHOW_ACTIVE_TOOLCHAIN_HELP: &str = r"DISCUSSION:
     You should use `rustc --print sysroot` to get the sysroot, or
     `rustc --version` to get the toolchain version.";
 
-pub static UPDATE_HELP: &str = r"DISCUSSION:
+pub(crate) static UPDATE_HELP: &str = r"DISCUSSION:
     With no toolchain specified, the `update` command updates each of
     the installed toolchains from the official release channels, then
     updates rustup itself.
 
     If given a toolchain argument then `update` updates that
     toolchain, the same as `rustup toolchain install`.";
 
-pub static INSTALL_HELP: &str = r"DISCUSSION:
+pub(crate) static INSTALL_HELP: &str = r"DISCUSSION:
     Installs a specific rust toolchain.
 
     The 'install' command is an alias for 'rustup update <toolchain>'.";
 
-pub static DEFAULT_HELP: &str = r"DISCUSSION:
+pub(crate) static DEFAULT_HELP: &str = r"DISCUSSION:
     Sets the default toolchain to the one specified. If the toolchain
     is not already installed then it is installed first.";
 
-pub static TOOLCHAIN_HELP: &str = r"DISCUSSION:
+pub(crate) static TOOLCHAIN_HELP: &str = r"DISCUSSION:
     Many `rustup` commands deal with *toolchains*, a single
     installation of the Rust compiler. `rustup` supports multiple
     types of toolchains. The most basic track the official release
@@ -85,7 +85,7 @@ pub static TOOLCHAIN_HELP: &str = r"DISCUSSION:
     often used for developing Rust itself. For more information see
     `rustup toolchain help link`.";
 
-pub static TOOLCHAIN_LINK_HELP: &str = r"DISCUSSION:
+pub(crate) static TOOLCHAIN_LINK_HELP: &str = r"DISCUSSION:
     'toolchain' is the custom name to be assigned to the new toolchain.
     Any name is permitted as long as it does not fully match an initial
     substring of a standard release channel. For example, you can use
@@ -104,7 +104,7 @@ pub static TOOLCHAIN_LINK_HELP: &str = r"DISCUSSION:
     If you now compile a crate in the current directory, the custom
     toolchain 'latest-stage1' will be used.";
 
-pub static OVERRIDE_HELP: &str = r"DISCUSSION:
+pub(crate) static OVERRIDE_HELP: &str = r"DISCUSSION:
     Overrides configure Rustup to use a specific toolchain when
     running in a specific directory.
 
@@ -125,14 +125,14 @@ pub static OVERRIDE_HELP: &str = r"DISCUSSION:
     override and use the default toolchain again, `rustup override
     unset`.";
 
-pub static OVERRIDE_UNSET_HELP: &str = r"DISCUSSION:
+pub(crate) static OVERRIDE_UNSET_HELP: &str = r"DISCUSSION:
     If `--path` argument is present, removes the override toolchain
     for the specified directory. If `--nonexistent` argument is
     present, removes the override toolchain for all nonexistent
     directories. Otherwise, removes the override toolchain for the
     current directory.";
 
-pub static RUN_HELP: &str = r"DISCUSSION:
+pub(crate) static RUN_HELP: &str = r"DISCUSSION:
     Configures an environment to use the given toolchain and then runs
     the specified program. The command may be any program, not just
     rustc or cargo. This can be used for testing arbitrary toolchains
@@ -147,14 +147,14 @@ pub static RUN_HELP: &str = r"DISCUSSION:
 
         $ rustup run nightly cargo build";
 
-pub static DOC_HELP: &str = r"DISCUSSION:
+pub(crate) static DOC_HELP: &str = r"DISCUSSION:
     Opens the documentation for the currently active toolchain with
     the default browser.
 
     By default, it opens the documentation index. Use the various
     flags to open specific pieces of documentation.";
 
-pub static COMPLETIONS_HELP: &str = r"DISCUSSION:
+pub(crate) static COMPLETIONS_HELP: &str = r"DISCUSSION:
     Enable tab completion for Bash, Fish, Zsh, or PowerShell
     The script is output on `stdout`, allowing one to re-direct the
     output to the file of their choosing. Where you place the file
@@ -274,11 +274,11 @@ pub static COMPLETIONS_HELP: &str = r"DISCUSSION:
 
         $ rustup completions zsh cargo > ~/.zfunc/_cargo";
 
-pub static TOOLCHAIN_ARG_HELP: &str = "Toolchain name, such as 'stable', 'nightly', \
+pub(crate) static TOOLCHAIN_ARG_HELP: &str = "Toolchain name, such as 'stable', 'nightly', \
                                        or '1.8.0'. For more information see `rustup \
                                        help toolchain`";
 
-pub static TOPIC_ARG_HELP: &str = "Topic such as 'core', 'fn', 'usize', 'eprintln!', \
+pub(crate) static TOPIC_ARG_HELP: &str = "Topic such as 'core', 'fn', 'usize', 'eprintln!', \
                                    'core::arch', 'alloc::format!', 'std::fs', \
                                    'std::fs::read_dir', 'std::io::Bytes', \
                                    'std::iter::Sum', 'std::io::error::Result' etc...";

src/cli/job.rs

@@ -19,17 +19,17 @@
 
 #![allow(clippy::missing_safety_doc)]
 
-pub use self::imp::Setup;
+pub(crate) use self::imp::Setup;
 
-pub fn setup() -> Option<Setup> {
+pub(crate) fn setup() -> Option<Setup> {
     unsafe { imp::setup() }
 }
 
 #[cfg(unix)]
 mod imp {
-    pub type Setup = ();
+    pub(crate) type Setup = ();
 
-    pub unsafe fn setup() -> Option<()> {
+    pub(crate) unsafe fn setup() -> Option<()> {
         Some(())
     }
 }
@@ -47,19 +47,19 @@ mod imp {
     use winapi::um::winnt::HANDLE;
     use winapi::um::winnt::*;
 
-    pub struct Setup {
+    pub(crate) struct Setup {
         job: Handle,
     }
 
-    pub struct Handle {
+    pub(crate) struct Handle {
         inner: HANDLE,
     }
 
     fn last_err() -> io::Error {
         io::Error::last_os_error()
     }
 
-    pub unsafe fn setup() -> Option<Setup> {
+    pub(crate) unsafe fn setup() -> Option<Setup> {
         // Creates a new job object for us to use and then adds ourselves to it.
         // Note that all errors are basically ignored in this function,
         // intentionally. Job objects are "relatively new" in Windows,

src/cli/log.rs

@@ -23,7 +23,7 @@ macro_rules! debug {
     ( $ ( $ arg : tt ) * ) => ( $crate::cli::log::debug_fmt ( format_args ! ( $ ( $ arg ) * ) ) )
 }
 
-pub fn warn_fmt(args: fmt::Arguments<'_>) {
+pub(crate) fn warn_fmt(args: fmt::Arguments<'_>) {
     let mut t = term2::stderr();
     let _ = t.fg(term2::color::YELLOW);
     let _ = t.attr(term2::Attr::Bold);
@@ -33,7 +33,7 @@ pub fn warn_fmt(args: fmt::Arguments<'_>) {
     let _ = writeln!(t);
 }
 
-pub fn err_fmt(args: fmt::Arguments<'_>) {
+pub(crate) fn err_fmt(args: fmt::Arguments<'_>) {
     let mut t = term2::stderr();
     let _ = t.fg(term2::color::RED);
     let _ = t.attr(term2::Attr::Bold);
@@ -43,7 +43,7 @@ pub fn err_fmt(args: fmt::Arguments<'_>) {
     let _ = writeln!(t);
 }
 
-pub fn info_fmt(args: fmt::Arguments<'_>) {
+pub(crate) fn info_fmt(args: fmt::Arguments<'_>) {
     let mut t = term2::stderr();
     let _ = t.attr(term2::Attr::Bold);
     let _ = write!(t, "info: ");
@@ -52,7 +52,7 @@ pub fn info_fmt(args: fmt::Arguments<'_>) {
     let _ = writeln!(t);
 }
 
-pub fn verbose_fmt(args: fmt::Arguments<'_>) {
+pub(crate) fn verbose_fmt(args: fmt::Arguments<'_>) {
     let mut t = term2::stderr();
     let _ = t.fg(term2::color::MAGENTA);
     let _ = t.attr(term2::Attr::Bold);
@@ -62,7 +62,7 @@ pub fn verbose_fmt(args: fmt::Arguments<'_>) {
     let _ = writeln!(t);
 }
 
-pub fn debug_fmt(args: fmt::Arguments<'_>) {
+pub(crate) fn debug_fmt(args: fmt::Arguments<'_>) {
     if process().var("RUSTUP_DEBUG").is_ok() {
         let mut t = term2::stderr();
         let _ = t.fg(term2::color::BLUE);

src/cli/markdown.rs

@@ -11,7 +11,7 @@ struct LineWrapper<'a, T: Terminal> {
     indent: u32,
     margin: u32,
     pos: u32,
-    pub w: &'a mut T,
+    w: &'a mut T,
 }
 
 impl<'a, T: Terminal + 'a> LineWrapper<'a, T> {
@@ -221,7 +221,7 @@ impl<'a, T: Terminal + io::Write + 'a> LineFormatter<'a, T> {
     }
 }
 
-pub fn md<'a, S: AsRef<str>, T: Terminal + io::Write + 'a>(t: &'a mut T, content: S) {
+pub(crate) fn md<'a, S: AsRef<str>, T: Terminal + io::Write + 'a>(t: &'a mut T, content: S) {
     let mut f = LineFormatter::new(t, 0, 79);
     let parser = pulldown_cmark::Parser::new(content.as_ref());
     for event in parser {