1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70

//! Utilities for working with rustdoc JSON.
//!
//! # Building
//!
//! Use [`rustdoc_json::Builder`][Builder] to build rustdoc JSON. Like this:
//!
//! ```no_run
//! let json_path = rustdoc_json::Builder::default()
//!     .toolchain("nightly")
//!     .manifest_path("Cargo.toml")
//!     .build()
//!     .unwrap();
//!
//! println!("Built and wrote rustdoc JSON to {:?}", &json_path);
//! ```
//!
//! A compilable example can be found
//! [here](https://github.com/Enselic/cargo-public-api/blob/main/rustdoc-json/examples/build-rustdoc-json.rs)

// deny in CI, only warn here
#![warn(clippy::all, missing_docs)]

use std::path::PathBuf;

mod builder;
pub use builder::{Builder, Color, PackageTarget};

/// Represents all errors that can occur when using [`Builder::build()`].
#[derive(thiserror::Error, Debug)]
#[non_exhaustive]
pub enum BuildError {
    /// You tried to generate rustdoc JSON for a virtual manifest. That does not
    /// work. You need to point to the manifest of a real package.
    #[error("Manifest must be for an actual package. `{0:?}` is a virtual manifest")]
    VirtualManifest(PathBuf),

    /// A general error. Refer to the attached error message for more info.
    #[error("Failed to build rustdoc JSON: {0}")]
    General(String),

    /// An error originating from building the rustdoc JSON for a crate.
    ///
    /// In this case the user will see the exact errors on stderr, regardless of
    /// if stderr was printed to the terminal or captured with
    /// [`Builder::build_with_captured_output()`].
    #[error("Failed to build rustdoc JSON (see stderr)")]
    BuildRustdocJsonError,

    /// Occcurs when stdout or stderr could not be captured when using
    /// [`Builder::build_with_captured_output()`]).
    #[error("Failed to capture output: {0}")]
    CapturedOutputError(String),

    /// Occurs when a command could not be executed, e.g. because the binary
    /// that we tried to run did not exist.
    #[error("Failed to execute: {0}")]
    CommandExecutionError(String),

    /// An error originating from `cargo-manifest`.
    #[error(transparent)]
    CargoManifestError(#[from] cargo_manifest::Error),

    /// An error originating from `cargo_metadata`.
    #[error(transparent)]
    CargoMetadataError(#[from] cargo_metadata::Error),

    /// Some kind of IO error occurred.
    #[error(transparent)]
    IoError(#[from] std::io::Error),
}