Skip to content

Commit 8d61aa3

Browse files
committed
Make all src functions and structs crate-private
Signed-off-by: hi-rustin <[email protected]> Fmt code Signed-off-by: hi-rustin <[email protected]>
1 parent a441c41 commit 8d61aa3

11 files changed

+71
-72
lines changed

src/cli.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ pub mod log;
44
pub mod common;
55
mod download_tracker;
66
pub mod errors;
7-
pub mod help;
7+
mod help;
88
mod job;
99
mod markdown;
1010
pub mod proxy_mode;

src/config.rs

+32-31
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ impl<T: Into<String>> From<T> for OverrideFile {
8686
}
8787

8888
#[derive(Debug)]
89-
pub enum OverrideReason {
89+
pub(crate) enum OverrideReason {
9090
Environment,
9191
CommandLine,
9292
OverrideDB(PathBuf),
@@ -170,7 +170,7 @@ pub enum PgpPublicKey {
170170

171171
impl PgpPublicKey {
172172
/// Retrieve the key.
173-
pub fn key(&self) -> &SignedPublicKey {
173+
pub(crate) fn key(&self) -> &SignedPublicKey {
174174
match self {
175175
Self::Builtin => &*BUILTIN_PGP_KEY,
176176
Self::FromEnvironment(_, k) => k,
@@ -179,7 +179,7 @@ impl PgpPublicKey {
179179
}
180180

181181
/// Display the key in detail for the user
182-
pub fn show_key(&self) -> Result<Vec<String>> {
182+
pub(crate) fn show_key(&self) -> Result<Vec<String>> {
183183
fn format_hex(bytes: &[u8], separator: &str, every: usize) -> Result<String> {
184184
use std::fmt::Write;
185185
let mut ret = String::new();
@@ -226,7 +226,7 @@ impl Display for PgpPublicKey {
226226
}
227227
}
228228

229-
pub const UNIX_FALLBACK_SETTINGS: &str = "/etc/rustup/settings.toml";
229+
pub(crate) const UNIX_FALLBACK_SETTINGS: &str = "/etc/rustup/settings.toml";
230230

231231
pub struct Cfg {
232232
profile_override: Option<dist::Profile>,
@@ -241,7 +241,6 @@ pub struct Cfg {
241241
pub toolchain_override: Option<String>,
242242
pub env_override: Option<String>,
243243
pub dist_root_url: String,
244-
pub dist_root_server: String,
245244
pub notify_handler: Arc<dyn Fn(Notification<'_>)>,
246245
}
247246

@@ -330,7 +329,7 @@ impl Cfg {
330329
dist_root_server.as_str(),
331330
Box::new(move |n| (notify_clone)(n.into())),
332331
);
333-
let dist_root = dist_root_server.clone() + "/dist";
332+
let dist_root = dist_root_server + "/dist";
334333

335334
let cfg = Self {
336335
profile_override: None,
@@ -346,7 +345,6 @@ impl Cfg {
346345
toolchain_override: None,
347346
env_override,
348347
dist_root_url: dist_root,
349-
dist_root_server,
350348
};
351349

352350
// Run some basic checks against the constructed configuration
@@ -372,15 +370,15 @@ impl Cfg {
372370
}
373371
}
374372

375-
pub fn get_pgp_keys(&self) -> &[PgpPublicKey] {
373+
pub(crate) fn get_pgp_keys(&self) -> &[PgpPublicKey] {
376374
&self.pgp_keys
377375
}
378376

379377
pub(crate) fn set_profile_override(&mut self, profile: dist::Profile) {
380378
self.profile_override = Some(profile);
381379
}
382380

383-
pub fn set_default(&self, toolchain: &str) -> Result<()> {
381+
pub(crate) fn set_default(&self, toolchain: &str) -> Result<()> {
384382
self.settings_file.with_mut(|s| {
385383
s.default_toolchain = Some(toolchain.to_owned());
386384
Ok(())
@@ -389,7 +387,7 @@ impl Cfg {
389387
Ok(())
390388
}
391389

392-
pub fn set_profile(&mut self, profile: &str) -> Result<()> {
390+
pub(crate) fn set_profile(&mut self, profile: &str) -> Result<()> {
393391
match Profile::from_str(profile) {
394392
Ok(p) => {
395393
self.profile_override = None;
@@ -404,7 +402,7 @@ impl Cfg {
404402
}
405403
}
406404

407-
pub fn set_auto_self_update(&mut self, mode: &str) -> Result<()> {
405+
pub(crate) fn set_auto_self_update(&mut self, mode: &str) -> Result<()> {
408406
match SelfUpdateMode::from_str(mode) {
409407
Ok(update_mode) => {
410408
self.settings_file.with_mut(|s| {
@@ -418,7 +416,7 @@ impl Cfg {
418416
}
419417
}
420418

421-
pub fn set_toolchain_override(&mut self, toolchain_override: &str) {
419+
pub(crate) fn set_toolchain_override(&mut self, toolchain_override: &str) {
422420
self.toolchain_override = Some(toolchain_override.to_owned());
423421
}
424422

@@ -442,7 +440,7 @@ impl Cfg {
442440
})
443441
}
444442

445-
pub fn get_self_update_mode(&self) -> Result<SelfUpdateMode> {
443+
pub(crate) fn get_self_update_mode(&self) -> Result<SelfUpdateMode> {
446444
self.settings_file.with(|s| {
447445
let mode = match &s.auto_self_update {
448446
Some(mode) => mode.clone(),
@@ -452,7 +450,7 @@ impl Cfg {
452450
})
453451
}
454452

455-
pub fn get_toolchain(&self, name: &str, create_parent: bool) -> Result<Toolchain<'_>> {
453+
pub(crate) fn get_toolchain(&self, name: &str, create_parent: bool) -> Result<Toolchain<'_>> {
456454
if create_parent {
457455
utils::ensure_dir_exists("toolchains", &self.toolchains_dir, &|n| {
458456
(self.notify_handler)(n)
@@ -462,7 +460,7 @@ impl Cfg {
462460
Toolchain::from(self, name)
463461
}
464462

465-
pub fn get_hash_file(&self, toolchain: &str, create_parent: bool) -> Result<PathBuf> {
463+
pub(crate) fn get_hash_file(&self, toolchain: &str, create_parent: bool) -> Result<PathBuf> {
466464
if create_parent {
467465
utils::ensure_dir_exists(
468466
"update-hash",
@@ -474,7 +472,7 @@ impl Cfg {
474472
Ok(self.update_hash_dir.join(toolchain))
475473
}
476474

477-
pub fn which_binary_by_toolchain(
475+
pub(crate) fn which_binary_by_toolchain(
478476
&self,
479477
toolchain: &str,
480478
binary: &str,
@@ -487,12 +485,12 @@ impl Cfg {
487485
}
488486
}
489487

490-
pub fn which_binary(&self, path: &Path, binary: &str) -> Result<Option<PathBuf>> {
488+
pub(crate) fn which_binary(&self, path: &Path, binary: &str) -> Result<Option<PathBuf>> {
491489
let (toolchain, _) = self.find_or_install_override_toolchain_or_default(path)?;
492490
Ok(Some(toolchain.binary_file(binary)))
493491
}
494492

495-
pub fn upgrade_data(&self) -> Result<()> {
493+
pub(crate) fn upgrade_data(&self) -> Result<()> {
496494
let current_version = self.settings_file.with(|s| Ok(s.version.clone()))?;
497495

498496
if current_version == DEFAULT_METADATA_VERSION {
@@ -532,7 +530,7 @@ impl Cfg {
532530
}
533531
}
534532

535-
pub fn find_default(&self) -> Result<Option<Toolchain<'_>>> {
533+
pub(crate) fn find_default(&self) -> Result<Option<Toolchain<'_>>> {
536534
let opt_name = self.get_default()?;
537535

538536
if let Some(name) = opt_name {
@@ -543,7 +541,10 @@ impl Cfg {
543541
}
544542
}
545543

546-
pub fn find_override(&self, path: &Path) -> Result<Option<(Toolchain<'_>, OverrideReason)>> {
544+
pub(crate) fn find_override(
545+
&self,
546+
path: &Path,
547+
) -> Result<Option<(Toolchain<'_>, OverrideReason)>> {
547548
self.find_override_config(path).map(|opt| {
548549
opt.and_then(|(override_cfg, reason)| {
549550
override_cfg.toolchain.map(|toolchain| (toolchain, reason))
@@ -722,7 +723,7 @@ impl Cfg {
722723
}
723724
}
724725

725-
pub fn find_or_install_override_toolchain_or_default(
726+
pub(crate) fn find_or_install_override_toolchain_or_default(
726727
&self,
727728
path: &Path,
728729
) -> Result<(Toolchain<'_>, Option<OverrideReason>)> {
@@ -819,7 +820,7 @@ impl Cfg {
819820
}
820821
}
821822

822-
pub fn get_default(&self) -> Result<Option<String>> {
823+
pub(crate) fn get_default(&self) -> Result<Option<String>> {
823824
let user_opt = self.settings_file.with(|s| Ok(s.default_toolchain.clone()));
824825
if let Some(fallback_settings) = &self.fallback_settings {
825826
match user_opt {
@@ -830,7 +831,7 @@ impl Cfg {
830831
user_opt
831832
}
832833

833-
pub fn list_toolchains(&self) -> Result<Vec<String>> {
834+
pub(crate) fn list_toolchains(&self) -> Result<Vec<String>> {
834835
if utils::is_directory(&self.toolchains_dir) {
835836
let mut toolchains: Vec<_> = utils::read_dir("toolchains", &self.toolchains_dir)?
836837
.filter_map(io::Result::ok)
@@ -846,7 +847,7 @@ impl Cfg {
846847
}
847848
}
848849

849-
pub fn list_channels(&self) -> Result<Vec<(String, Result<Toolchain<'_>>)>> {
850+
pub(crate) fn list_channels(&self) -> Result<Vec<(String, Result<Toolchain<'_>>)>> {
850851
let toolchains = self.list_toolchains()?;
851852

852853
// Convert the toolchain strings to Toolchain values
@@ -859,7 +860,7 @@ impl Cfg {
859860
.collect())
860861
}
861862

862-
pub fn update_all_channels(
863+
pub(crate) fn update_all_channels(
863864
&self,
864865
force_update: bool,
865866
) -> Result<Vec<(String, Result<UpdateStatus>)>> {
@@ -883,7 +884,7 @@ impl Cfg {
883884
Ok(channels.collect())
884885
}
885886

886-
pub fn check_metadata_version(&self) -> Result<()> {
887+
pub(crate) fn check_metadata_version(&self) -> Result<()> {
887888
utils::assert_is_directory(&self.rustup_dir)?;
888889

889890
self.settings_file.with(|s| {
@@ -898,14 +899,14 @@ impl Cfg {
898899
})
899900
}
900901

901-
pub fn toolchain_for_dir(
902+
pub(crate) fn toolchain_for_dir(
902903
&self,
903904
path: &Path,
904905
) -> Result<(Toolchain<'_>, Option<OverrideReason>)> {
905906
self.find_or_install_override_toolchain_or_default(path)
906907
}
907908

908-
pub fn create_command_for_dir(&self, path: &Path, binary: &str) -> Result<Command> {
909+
pub(crate) fn create_command_for_dir(&self, path: &Path, binary: &str) -> Result<Command> {
909910
let (ref toolchain, _) = self.toolchain_for_dir(path)?;
910911

911912
if let Some(cmd) = self.maybe_do_cargo_fallback(toolchain, binary)? {
@@ -918,7 +919,7 @@ impl Cfg {
918919
}
919920
}
920921

921-
pub fn create_command_for_toolchain(
922+
pub(crate) fn create_command_for_toolchain(
922923
&self,
923924
toolchain: &str,
924925
install_if_missing: bool,
@@ -974,7 +975,7 @@ impl Cfg {
974975
Ok(None)
975976
}
976977

977-
pub fn set_default_host_triple(&self, host_triple: &str) -> Result<()> {
978+
pub(crate) fn set_default_host_triple(&self, host_triple: &str) -> Result<()> {
978979
// Ensure that the provided host_triple is capable of resolving
979980
// against the 'stable' toolchain. This provides early errors
980981
// if the supplied triple is insufficient / bad.
@@ -997,7 +998,7 @@ impl Cfg {
997998
.unwrap_or_else(dist::TargetTriple::from_host_or_build))
998999
}
9991000

1000-
pub fn resolve_toolchain(&self, name: &str) -> Result<String> {
1001+
pub(crate) fn resolve_toolchain(&self, name: &str) -> Result<String> {
10011002
if let Ok(desc) = dist::PartialToolchainDesc::from_str(name) {
10021003
let host = self.get_default_host_triple()?;
10031004
Ok(desc.resolve(&host)?.to_string())

src/currentprocess.rs

+7-7
Original file line numberDiff line numberDiff line change
@@ -191,13 +191,13 @@ impl ProcessSource for OSProcess {
191191

192192
#[derive(Clone, Debug, Default)]
193193
pub struct TestProcess {
194-
pub(crate) cwd: PathBuf,
195-
pub(crate) args: Vec<String>,
196-
pub(crate) vars: HashMap<String, String>,
197-
pub(crate) id: u64,
198-
pub(crate) stdin: TestStdinInner,
199-
pub(crate) stdout: TestWriterInner,
200-
pub(crate) stderr: TestWriterInner,
194+
pub cwd: PathBuf,
195+
pub args: Vec<String>,
196+
pub vars: HashMap<String, String>,
197+
pub id: u64,
198+
pub stdin: TestStdinInner,
199+
pub stdout: TestWriterInner,
200+
pub stderr: TestWriterInner,
201201
}
202202

203203
impl TestProcess {

src/env_var.rs

+3-3
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ use crate::process;
77
pub const RUST_RECURSION_COUNT_MAX: u32 = 20;
88

99
#[allow(unused)]
10-
pub fn append_path(name: &str, value: Vec<PathBuf>, cmd: &mut Command) {
10+
fn append_path(name: &str, value: Vec<PathBuf>, cmd: &mut Command) {
1111
let old_value = process().var_os(name);
1212
let mut parts: Vec<PathBuf>;
1313
if let Some(ref v) = old_value {
@@ -21,7 +21,7 @@ pub fn append_path(name: &str, value: Vec<PathBuf>, cmd: &mut Command) {
2121
}
2222
}
2323

24-
pub fn prepend_path(name: &str, value: Vec<PathBuf>, cmd: &mut Command) {
24+
pub(crate) fn prepend_path(name: &str, value: Vec<PathBuf>, cmd: &mut Command) {
2525
let old_value = process().var_os(name);
2626
let mut parts: Vec<PathBuf>;
2727
if let Some(ref v) = old_value {
@@ -36,7 +36,7 @@ pub fn prepend_path(name: &str, value: Vec<PathBuf>, cmd: &mut Command) {
3636
}
3737
}
3838

39-
pub fn inc(name: &str, cmd: &mut Command) {
39+
pub(crate) fn inc(name: &str, cmd: &mut Command) {
4040
let old_value = process()
4141
.var(name)
4242
.ok()

src/errors.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ use url::Url;
1010

1111
use crate::dist::manifest::{Component, Manifest};
1212

13-
pub const TOOLSTATE_MSG: &str =
13+
const TOOLSTATE_MSG: &str =
1414
"If you require these components, please install and use the latest successful build version,\n\
1515
which you can find at <https://rust-lang.github.io/rustup-components-history>.\n\nAfter determining \
1616
the correct date, install it with a command such as:\n\n \

src/fallback_settings.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ impl Default for FallbackSettings {
2020
}
2121

2222
impl FallbackSettings {
23-
pub fn new<P: AsRef<Path>>(path: P) -> Result<Option<Self>> {
23+
pub(crate) fn new<P: AsRef<Path>>(path: P) -> Result<Option<Self>> {
2424
// Users cannot fix issues with missing/unreadable/invalid centralised files, but logging isn't setup early so
2525
// we can't simply trap all errors and log diagnostics. Ideally we would, and then separate these into different
2626
// sorts of issues, logging messages about errors that should be fixed. Instead we trap some conservative errors

src/install.rs

+3-4
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,11 @@ use crate::dist::prefix::InstallPrefix;
1010
use crate::dist::Notification;
1111
use crate::errors::RustupError;
1212
use crate::notifications::Notification as RootNotification;
13-
use crate::toolchain::{CustomToolchain, DistributableToolchain, Toolchain, UpdateStatus};
13+
use crate::toolchain::{CustomToolchain, Toolchain, UpdateStatus};
1414
use crate::utils::utils;
1515

1616
#[derive(Copy, Clone)]
17-
pub enum InstallMethod<'a> {
17+
pub(crate) enum InstallMethod<'a> {
1818
Copy(&'a Path, &'a CustomToolchain<'a>),
1919
Link(&'a Path, &'a CustomToolchain<'a>),
2020
// bool is whether to force an update
@@ -35,13 +35,12 @@ pub enum InstallMethod<'a> {
3535
components: &'a [&'a str],
3636
// Extra targets to install from dist
3737
targets: &'a [&'a str],
38-
distributable: &'a DistributableToolchain<'a>,
3938
},
4039
}
4140

4241
impl<'a> InstallMethod<'a> {
4342
// Install a toolchain
44-
pub fn install(&self, toolchain: &Toolchain<'a>) -> Result<UpdateStatus> {
43+
pub(crate) fn install(&self, toolchain: &Toolchain<'a>) -> Result<UpdateStatus> {
4544
let previous_version = if toolchain.exists() {
4645
Some(toolchain.rustc_version())
4746
} else {

0 commit comments

Comments
 (0)