use crate::here;
use anyhow::{bail, Context, Result};
use rustdoc_types::{Crate, FORMAT_VERSION};
use serde::Deserialize;
use std::fs;
use std::path::PathBuf;
use std::process::{Command, Output};
#[derive(Deserialize)]
struct CrateFormatVersion {
format_version: u32,
}
pub struct CargoRustDocJson {
crate_name: String,
crate_path: PathBuf,
target_path: PathBuf,
features: Vec<String>,
}
impl CargoRustDocJson {
pub fn new(
crate_name: impl Into<String>,
crate_path: impl Into<PathBuf>,
target_path: impl Into<PathBuf>,
features: Vec<String>,
) -> Self {
CargoRustDocJson {
crate_name: crate_name.into(),
crate_path: crate_path.into(),
target_path: target_path.into(),
features,
}
}
pub fn run(&self) -> Result<Crate> {
let cargo = std::env::var("CARGO").unwrap_or_else(|_| "cargo".to_string());
let mut command = Command::new(cargo);
command.current_dir(&self.crate_path).arg("rustdoc");
if !self.features.is_empty() {
command.arg("--no-default-features").arg("--features");
command.arg(&self.features.join(","));
}
command
.arg("--")
.arg("--document-private-items")
.arg("-Z")
.arg("unstable-options")
.arg("--output-format")
.arg("json");
let output = command
.output()
.context(here!("failed to run nightly rustdoc"))?;
handle_failure("rustdoc", &output)?;
let output_file_name = self
.target_path
.canonicalize()
.context(here!("failed to canonicalize {:?}", self.target_path))?
.join(format!("doc/{}.json", self.crate_name.replace('-', "_")));
let json = fs::read_to_string(output_file_name).context(here!())?;
let format_version: CrateFormatVersion = serde_json::from_str(&json)
.context("Failed to find `format_version` in rustdoc JSON output.")
.context(here!())?;
if format_version.format_version != FORMAT_VERSION {
bail!(
"The version of rustdoc being used produces JSON format version {0}, but \
this tool requires format version {1}. This can happen if the locally \
installed version of rustdoc doesn't match the rustdoc JSON types from \
the `rustdoc-types` crate.\n\n\
If this occurs with the latest Rust nightly and the latest version of this \
tool, then this is a bug, and the tool needs to be upgraded to the latest \
format version.\n\n\
Otherwise, you'll need to determine a Rust nightly version that matches \
this tool's supported format version (or vice versa).",
format_version.format_version,
FORMAT_VERSION
);
}
let package: Crate = serde_json::from_str(&json)
.context("Failed to parse rustdoc output.")
.context(here!())?;
Ok(package)
}
}
pub fn handle_failure(operation_name: &str, output: &Output) -> Result<(), anyhow::Error> {
if !output.status.success() {
return Err(capture_error(operation_name, output));
}
Ok(())
}
pub fn capture_error(operation_name: &str, output: &Output) -> anyhow::Error {
let message = format!(
"Failed to {name}:\nStatus: {status}\nStdout: {stdout}\nStderr: {stderr}\n",
name = operation_name,
status = if let Some(code) = output.status.code() {
format!("{}", code)
} else {
"Killed by signal".to_string()
},
stdout = String::from_utf8_lossy(&output.stdout),
stderr = String::from_utf8_lossy(&output.stderr)
);
anyhow::Error::msg(message)
}