From d6c7b2026bca5cdd149086a3e9ebb062fe52ba40 Mon Sep 17 00:00:00 2001 From: Weihang Lo Date: Fri, 15 Sep 2023 16:02:12 +0800 Subject: [PATCH] refactor: `alt_registry_key` -> `registry_key` Given we remove `SourceId::name` field, `alt_registry_key` is no longer only for alternative registries. --- src/cargo/core/source_id.rs | 22 +++++++++++----------- src/cargo/ops/registry/mod.rs | 2 +- src/cargo/util/auth/mod.rs | 6 +++--- src/cargo/util/config/mod.rs | 2 +- 4 files changed, 16 insertions(+), 16 deletions(-) diff --git a/src/cargo/core/source_id.rs b/src/cargo/core/source_id.rs index a702eff68662..76b60dac8a52 100644 --- a/src/cargo/core/source_id.rs +++ b/src/cargo/core/source_id.rs @@ -51,10 +51,10 @@ struct SourceIdInner { kind: SourceKind, /// For example, the exact Git revision of the specified branch for a Git Source. precise: Option, - /// Name of the alt registry in the `[registries]` table. - /// WARNING: this is not always set for alt-registries when the name is - /// not known. - alt_registry_key: Option, + /// Name of the remote registry as defined in the `[registries]` table. + /// + /// WARNING: this is not always set for alt-registries when the name is not known. + registry_key: Option, } /// The possible kinds of code source. @@ -107,7 +107,7 @@ impl SourceId { canonical_url: CanonicalUrl::new(&url)?, url, precise: None, - alt_registry_key: key.map(|k| k.into()), + registry_key: key.map(|k| k.into()), }); Ok(source_id) } @@ -315,7 +315,7 @@ impl SourceId { pub fn display_registry_name(self) -> String { if self.is_crates_io() { CRATES_IO_REGISTRY.to_string() - } else if let Some(key) = &self.inner.alt_registry_key { + } else if let Some(key) = &self.inner.registry_key { key.clone() } else if self.precise().is_some() { // We remove `precise` here to retrieve an permissive version of @@ -327,10 +327,10 @@ impl SourceId { } /// Gets the name of the remote registry as defined in the `[registries]` table. - /// WARNING: alt registries that come from Cargo.lock, or --index will - /// not have a name. - pub fn alt_registry_key(&self) -> Option<&str> { - self.inner.alt_registry_key.as_deref() + /// + /// WARNING: alt registries that come from Cargo.lock, or `--index` will not have a name. + pub fn registry_key(&self) -> Option<&str> { + self.inner.registry_key.as_deref() } /// Returns `true` if this source is from a filesystem path. @@ -646,7 +646,7 @@ impl Hash for SourceId { /// such as [`name`] and [`alt_registry_key`]. That's why this is not derived. /// /// [`name`]: SourceIdInner::name -/// [`alt_registry_key`]: SourceIdInner::alt_registry_key +/// [`registry_key`]: SourceIdInner::registry_key impl Hash for SourceIdInner { fn hash(&self, into: &mut S) { self.kind.hash(into); diff --git a/src/cargo/ops/registry/mod.rs b/src/cargo/ops/registry/mod.rs index 7d4e99f6bcb4..b61f58f1fff6 100644 --- a/src/cargo/ops/registry/mod.rs +++ b/src/cargo/ops/registry/mod.rs @@ -188,7 +188,7 @@ fn get_source_id( .replaced_source_id(); if reg.is_none() && index.is_none() && replacement_sid != builtin_replacement_sid { // Neither --registry nor --index was passed and the user has configured source-replacement. - if let Some(replacement_name) = replacement_sid.alt_registry_key() { + if let Some(replacement_name) = replacement_sid.registry_key() { bail!("crates-io is replaced with remote registry {replacement_name};\ninclude `--registry {replacement_name}` or `--registry crates-io`"); } else { bail!("crates-io is replaced with non-remote-registry source {replacement_sid};\ninclude `--registry crates-io` to use crates.io"); diff --git a/src/cargo/util/auth/mod.rs b/src/cargo/util/auth/mod.rs index 0d522d586868..967fe320590e 100644 --- a/src/cargo/util/auth/mod.rs +++ b/src/cargo/util/auth/mod.rs @@ -315,7 +315,7 @@ fn registry_credential_config_raw_uncached( // If the name doesn't match, leave a note to help the user understand // the potentially confusing situation. if let Some(name) = name.as_deref() { - if Some(name) != sid.alt_registry_key() { + if Some(name) != sid.registry_key() { config.shell().note(format!( "name of alternative registry `{}` set to `{name}`", sid.url() @@ -420,7 +420,7 @@ impl fmt::Display for AuthorizationError { write!(f, "\nor use environment variable CARGO_REGISTRY_TOKEN")?; } Ok(()) - } else if let Some(name) = self.sid.alt_registry_key() { + } else if let Some(name) = self.sid.registry_key() { let key = ConfigKey::from_str(&format!("registries.{name}.token")); write!( f, @@ -480,7 +480,7 @@ fn credential_action( let name = if sid.is_crates_io() { Some(CRATES_IO_REGISTRY) } else { - sid.alt_registry_key() + sid.registry_key() }; let registry = RegistryInfo { index_url: sid.url().as_str(), diff --git a/src/cargo/util/config/mod.rs b/src/cargo/util/config/mod.rs index d6fba5db9de2..d7ae9ba52970 100644 --- a/src/cargo/util/config/mod.rs +++ b/src/cargo/util/config/mod.rs @@ -2240,7 +2240,7 @@ pub fn save_credentials( None } else { let name = registry - .alt_registry_key() + .registry_key() .ok_or_else(|| internal("can't save credentials for anonymous registry"))?; Some(name) };