Skip to content

Commit f42e241

Browse files
committed
make it clear that the CrossToml parse functions parse from strings
1 parent db4761b commit f42e241

File tree

4 files changed

+21
-21
lines changed

4 files changed

+21
-21
lines changed

src/config.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -603,7 +603,7 @@ mod tests {
603603

604604
fn toml(content: &str) -> Result<crate::CrossToml> {
605605
Ok(
606-
CrossToml::parse_from_cross(content, &mut MessageInfo::default())
606+
CrossToml::parse_from_cross_str(content, &mut MessageInfo::default())
607607
.wrap_err("couldn't parse toml")?
608608
.0,
609609
)

src/cross_toml.rs

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -123,23 +123,23 @@ pub struct CrossToml {
123123

124124
impl CrossToml {
125125
/// Parses the [`CrossToml`] from all of the config sources
126-
pub fn parse(
126+
pub fn parse_str(
127127
cargo_toml: &str,
128128
cross_toml: &str,
129129
msg_info: &mut MessageInfo,
130130
) -> Result<(Self, BTreeSet<String>)> {
131-
let (cross_toml, mut unused) = Self::parse_from_cross(cross_toml, msg_info)?;
131+
let (cross_toml, mut unused) = Self::parse_from_cross_str(cross_toml, msg_info)?;
132132

133-
if let Some((cargo_toml, u_cargo)) = Self::parse_from_cargo(cargo_toml, msg_info)? {
134-
unused.extend(u_cargo);
133+
if let Some((cargo_toml, u_cargo)) = Self::parse_from_cargo_str(cargo_toml, msg_info)? {
134+
unused.extend(u_cargo.into_iter());
135135
Ok((cargo_toml.merge(cross_toml)?, unused))
136136
} else {
137137
Ok((cross_toml, unused))
138138
}
139139
}
140140

141141
/// Parses the [`CrossToml`] from a string
142-
pub fn parse_from_cross(
142+
pub fn parse_from_cross_str(
143143
toml_str: &str,
144144
msg_info: &mut MessageInfo,
145145
) -> Result<(Self, BTreeSet<String>)> {
@@ -148,7 +148,7 @@ impl CrossToml {
148148
}
149149

150150
/// Parses the [`CrossToml`] from a string containing the Cargo.toml contents
151-
pub fn parse_from_cargo(
151+
pub fn parse_from_cargo_str(
152152
cargo_toml_str: &str,
153153
msg_info: &mut MessageInfo,
154154
) -> Result<Option<(Self, BTreeSet<String>)>> {
@@ -598,7 +598,7 @@ mod tests {
598598
targets: HashMap::new(),
599599
build: CrossBuildConfig::default(),
600600
};
601-
let (parsed_cfg, unused) = CrossToml::parse_from_cross("", &mut m!())?;
601+
let (parsed_cfg, unused) = CrossToml::parse_from_cross_str("", &mut m!())?;
602602

603603
assert_eq!(parsed_cfg, cfg);
604604
assert!(unused.is_empty());
@@ -633,7 +633,7 @@ mod tests {
633633
volumes = ["VOL1_ARG", "VOL2_ARG"]
634634
passthrough = ["VAR1", "VAR2"]
635635
"#;
636-
let (parsed_cfg, unused) = CrossToml::parse_from_cross(test_str, &mut m!())?;
636+
let (parsed_cfg, unused) = CrossToml::parse_from_cross_str(test_str, &mut m!())?;
637637

638638
assert_eq!(parsed_cfg, cfg);
639639
assert!(unused.is_empty());
@@ -705,7 +705,7 @@ mod tests {
705705
version = "2.17"
706706
image = "zig:local"
707707
"#;
708-
let (parsed_cfg, unused) = CrossToml::parse_from_cross(test_str, &mut m!())?;
708+
let (parsed_cfg, unused) = CrossToml::parse_from_cross_str(test_str, &mut m!())?;
709709

710710
assert_eq!(parsed_cfg, cfg);
711711
assert!(unused.is_empty());
@@ -791,7 +791,7 @@ mod tests {
791791
[target.aarch64-unknown-linux-gnu.env]
792792
volumes = ["VOL"]
793793
"#;
794-
let (parsed_cfg, unused) = CrossToml::parse_from_cross(test_str, &mut m!())?;
794+
let (parsed_cfg, unused) = CrossToml::parse_from_cross_str(test_str, &mut m!())?;
795795

796796
assert_eq!(parsed_cfg, cfg);
797797
assert!(unused.is_empty());
@@ -810,7 +810,7 @@ mod tests {
810810
cross = "1.2.3"
811811
"#;
812812

813-
let res = CrossToml::parse_from_cargo(test_str, &mut m!())?;
813+
let res = CrossToml::parse_from_cargo_str(test_str, &mut m!())?;
814814
assert!(res.is_none());
815815

816816
Ok(())
@@ -846,7 +846,7 @@ mod tests {
846846
xargo = true
847847
"#;
848848

849-
if let Some((parsed_cfg, _unused)) = CrossToml::parse_from_cargo(test_str, &mut m!())? {
849+
if let Some((parsed_cfg, _unused)) = CrossToml::parse_from_cargo_str(test_str, &mut m!())? {
850850
assert_eq!(parsed_cfg, cfg);
851851
} else {
852852
panic!("Parsing result is None");
@@ -977,9 +977,9 @@ mod tests {
977977
"#;
978978

979979
// Parses configs
980-
let (cfg1, _) = CrossToml::parse_from_cross(cfg1_str, &mut m!())?;
981-
let (cfg2, _) = CrossToml::parse_from_cross(cfg2_str, &mut m!())?;
982-
let (cfg_expected, _) = CrossToml::parse_from_cross(cfg_expected_str, &mut m!())?;
980+
let (cfg1, _) = CrossToml::parse_from_cross_str(cfg1_str, &mut m!())?;
981+
let (cfg2, _) = CrossToml::parse_from_cross_str(cfg2_str, &mut m!())?;
982+
let (cfg_expected, _) = CrossToml::parse_from_cross_str(cfg_expected_str, &mut m!())?;
983983

984984
// Merges config and compares
985985
let cfg_merged = cfg1.merge(cfg2)?;
@@ -1036,7 +1036,7 @@ mod tests {
10361036
[build]
10371037
pre-build = ["echo Hello World"]
10381038
"#;
1039-
let (toml, unused) = CrossToml::parse_from_cross(toml_str, &mut m!())?;
1039+
let (toml, unused) = CrossToml::parse_from_cross_str(toml_str, &mut m!())?;
10401040
assert!(unused.is_empty());
10411041
assert!(matches!(
10421042
toml.pre_build(&Target::new_built_in("aarch64-unknown-linux-gnu")),

src/lib.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -912,7 +912,7 @@ pub fn toml(metadata: &CargoMetadata, msg_info: &mut MessageInfo) -> Result<Opti
912912
let cross_toml_str = file::read(&cross_config_path)
913913
.wrap_err_with(|| format!("could not read file `{cross_config_path:?}`"))?;
914914

915-
let (config, _) = CrossToml::parse(&cargo_toml_str, &cross_toml_str, msg_info)
915+
let (config, _) = CrossToml::parse_str(&cargo_toml_str, &cross_toml_str, msg_info)
916916
.wrap_err_with(|| format!("failed to parse file `{cross_config_path:?}` as TOML",))?;
917917

918918
Ok(Some(config))
@@ -922,7 +922,7 @@ pub fn toml(metadata: &CargoMetadata, msg_info: &mut MessageInfo) -> Result<Opti
922922
msg_info.warn("There's a file named cross.toml, instead of Cross.toml. You may want to rename it, or it won't be considered.")?;
923923
}
924924

925-
if let Some((cfg, _)) = CrossToml::parse_from_cargo(&cargo_toml_str, msg_info)? {
925+
if let Some((cfg, _)) = CrossToml::parse_from_cargo_str(&cargo_toml_str, msg_info)? {
926926
Ok(Some(cfg))
927927
} else {
928928
Ok(None)

src/tests/toml.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -62,9 +62,9 @@ fn toml_check() -> Result<(), Box<dyn std::error::Error>> {
6262
);
6363
let mut msg_info = crate::shell::MessageInfo::default();
6464
let toml = if !cargo {
65-
crate::cross_toml::CrossToml::parse_from_cross(&fence_content, &mut msg_info)?
65+
crate::cross_toml::CrossToml::parse_from_cross_str(&fence_content, &mut msg_info)?
6666
} else {
67-
crate::cross_toml::CrossToml::parse_from_cargo(&fence_content, &mut msg_info)?
67+
crate::cross_toml::CrossToml::parse_from_cargo_str(&fence_content, &mut msg_info)?
6868
.unwrap_or_default()
6969
};
7070
assert!(toml.1.is_empty());

0 commit comments

Comments
 (0)