itsscb/cargo
1
0
Fork 0
mirror of https://github.com/rust-lang/cargo.git synced 2025-11-15 13:52:46 +00:00
Code Issues Packages Projects Releases Wiki Activity

refactor(manifest): Clean up field -> env var handling (#15008)

Browse Source 
### What does this PR try to resolve?

This is basically my PR feedback for #14973.

### How should we test and review this PR?

### Additional information
This commit is contained in:
Weihang Lo 2025-01-02 22:20:42 +00:00 committed by GitHub
commit 2939e969f5
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 34 additions and 50 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

84
src/cargo/core/manifest.rs
View File

@ -147,6 +147,24 @@ pub struct ManifestMetadata {
pub rust_version: Option<RustVersion>, pub rust_version: Option<RustVersion>,
} }
impl ManifestMetadata {
/// Whether the given env var should be tracked by Cargo's dep-info.
pub fn should_track(env_key: &str) -> bool {
let keys = MetadataEnvs::keys();
keys.iter().any(|k| *k == env_key)
}
pub fn env_var<'a>(&'a self, env_key: &str) -> Option<Cow<'a, str>> {
MetadataEnvs::var(self, env_key)
}
pub fn env_vars(&self) -> impl Iterator<Item = (&'static str, Cow<'_, str>)> {
MetadataEnvs::keys()
.iter()
.map(|k| (*k, MetadataEnvs::var(self, k).unwrap()))
}
}
macro_rules! get_metadata_env { macro_rules! get_metadata_env {
($meta:ident, $field:ident) => { ($meta:ident, $field:ident) => {
$meta.$field.as_deref().unwrap_or_default().into() $meta.$field.as_deref().unwrap_or_default().into()
@ -156,43 +174,24 @@ macro_rules! get_metadata_env {
}; };
} }
struct MetadataEnvs;
macro_rules! metadata_envs { macro_rules! metadata_envs {
( (
$( $(
($field:ident, $key:literal$(, $to_var:expr)?), ($field:ident, $key:literal$(, $to_var:expr)?),
)* )*
) => { ) => {
struct MetadataEnvs;
impl MetadataEnvs { impl MetadataEnvs {
$( fn keys() -> &'static [&'static str] {
fn $field(meta: &ManifestMetadata) -> Cow<'_, str> { &[$($key),*]
get_metadata_env!(meta, $field$(, $to_var)?)
}
)*
pub fn should_track(key: &str) -> bool {
let keys = [$($key),*];
key.strip_prefix("CARGO_PKG_")
.map(|key| keys.iter().any(|k| *k == key))
.unwrap_or_default()
} }
pub fn var<'a>(meta: &'a ManifestMetadata, key: &str) -> Option<Cow<'a, str>> { fn var<'a>(meta: &'a ManifestMetadata, key: &str) -> Option<Cow<'a, str>> {
key.strip_prefix("CARGO_PKG_").and_then(|key| match key { match key {
$($key => Some(Self::$field(meta)),)* $($key => Some(get_metadata_env!(meta, $field$(, $to_var)?)),)*
_ => None, _ => None,
}) }
}
pub fn vars(meta: &ManifestMetadata) -> impl Iterator<Item = (&'static str, Cow<'_, str>)> {
[
$(
(
concat!("CARGO_PKG_", $key),
Self::$field(meta),
),
)*
].into_iter()
} }
} }
} }
@ -202,29 +201,14 @@ macro_rules! metadata_envs {
// If these change we need to trigger a rebuild. // If these change we need to trigger a rebuild.
// NOTE: The env var name will be prefixed with `CARGO_PKG_` // NOTE: The env var name will be prefixed with `CARGO_PKG_`
metadata_envs! { metadata_envs! {
(description, "DESCRIPTION"), (description, "CARGO_PKG_DESCRIPTION"),
(homepage, "HOMEPAGE"), (homepage, "CARGO_PKG_HOMEPAGE"),
(repository, "REPOSITORY"), (repository, "CARGO_PKG_REPOSITORY"),
(license, "LICENSE"), (license, "CARGO_PKG_LICENSE"),
(license_file, "LICENSE_FILE"), (license_file, "CARGO_PKG_LICENSE_FILE"),
(authors, "AUTHORS", |m: &ManifestMetadata| m.authors.join(":")), (authors, "CARGO_PKG_AUTHORS", |m: &ManifestMetadata| m.authors.join(":")),
(rust_version, "RUST_VERSION", |m: &ManifestMetadata| m.rust_version.as_ref().map(ToString::to_string).unwrap_or_default()), (rust_version, "CARGO_PKG_RUST_VERSION", |m: &ManifestMetadata| m.rust_version.as_ref().map(ToString::to_string).unwrap_or_default()),
(readme, "README"), (readme, "CARGO_PKG_README"),
}
impl ManifestMetadata {
/// Whether the given env var should be tracked by Cargo's dep-info.
pub fn should_track(env_key: &str) -> bool {
MetadataEnvs::should_track(env_key)
}
pub fn env_var<'a>(&'a self, env_key: &str) -> Option<Cow<'a, str>> {
MetadataEnvs::var(self, env_key)
}
pub fn env_vars(&self) -> impl Iterator<Item = (&'static str, Cow<'_, str>)> {
MetadataEnvs::vars(self)
}
} }
#[derive(Clone, Hash, PartialEq, Eq, PartialOrd, Ord)] #[derive(Clone, Hash, PartialEq, Eq, PartialOrd, Ord)]