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 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204
#![deny(missing_docs)] //! Structured access to the output of `cargo metadata` //! Usually used from within a `cargo-*` executable //! //! ## Examples //! //! With [`std::env::args()`](https://doc.rust-lang.org/std/env/fn.args.html): //! //! ```rust //! # // This should be kept in sync with the equivalent example in the readme. //! # extern crate cargo_metadata; //! # use std::path::Path; //! let mut args = std::env::args().skip_while(|val| !val.starts_with("--manifest-path")); //! //! let manifest_path = match args.next() { //! Some(ref p) if p == "--manifest-path" => args.next(), //! Some(p) => Some(p.trim_left_matches("--manifest-path=").to_string()), //! None => None, //! }; //! //! let _metadata = cargo_metadata::metadata(manifest_path.as_ref().map(Path::new)).unwrap(); //! ``` //! //! With [`docopt`](https://docs.rs/docopt): //! //! ```rust //! # // This should be kept in sync with the equivalent example in the readme. //! # extern crate cargo_metadata; //! # extern crate docopt; //! # #[macro_use] extern crate serde_derive; //! # use std::path::Path; //! # use docopt::Docopt; //! # fn main() { //! const USAGE: &str = " //! Cargo metadata test function //! //! Usage: //! cargo_metadata [--manifest-path PATH] //! "; //! //! #[derive(Debug, Deserialize)] //! struct Args { //! arg_manifest_path: Option<String>, //! } //! //! let args: Args = Docopt::new(USAGE) //! .and_then(|d| d.deserialize()) //! .unwrap_or_else(|e| e.exit()); //! //! let _metadata = //! cargo_metadata::metadata(args.arg_manifest_path.as_ref().map(Path::new)).unwrap(); //! # } //! ``` //! //! With [`clap`](https://docs.rs/clap): //! //! ```rust //! # // This should be kept in sync with the equivalent example in the readme. //! # extern crate cargo_metadata; //! # extern crate clap; //! # use std::path::Path; //! //! let matches = clap::App::new("myapp") //! .arg( //! clap::Arg::with_name("manifest-path") //! .long("manifest-path") //! .value_name("PATH") //! .takes_value(true), //! ) //! .get_matches(); //! //! let _metadata = //! cargo_metadata::metadata(matches.value_of("manifest-path").map(Path::new)).unwrap(); //! ``` #[macro_use] extern crate error_chain; extern crate semver; extern crate serde; #[macro_use] extern crate serde_derive; extern crate serde_json; use std::collections::HashMap; use std::env; use std::path::Path; use std::process::Command; use std::str::from_utf8; pub use errors::{Error, Result}; pub use dependency::{Dependency, DependencyKind}; mod dependency; #[derive(Clone, Deserialize, Debug)] /// Starting point for metadata returned by `cargo metadata` pub struct Metadata { /// A list of all crates referenced by this crate (and the crate itself) pub packages: Vec<Package>, /// A list of all workspace members #[serde(default)] pub workspace_members: Vec<String>, /// Dependencies graph pub resolve: Option<Resolve>, version: usize, } #[derive(Clone, Deserialize, Debug)] /// A dependency graph pub struct Resolve { /// Nodes in a dependencies graph pub nodes: Vec<Node>, } #[derive(Clone, Deserialize, Debug)] /// A node in a dependencies graph pub struct Node { /// An opaque identifier for a package pub id: String, /// List of opaque identifiers for this node's dependencies pub dependencies: Vec<String>, } #[derive(Clone, Deserialize, Debug)] /// A crate pub struct Package { /// Name as given in the `Cargo.toml` pub name: String, /// Version given in the `Cargo.toml` pub version: String, /// An opaque identifier for a package pub id: String, source: Option<String>, /// List of dependencies of this particular package pub dependencies: Vec<Dependency>, /// Targets provided by the crate (lib, bin, example, test, ...) pub targets: Vec<Target>, features: HashMap<String, Vec<String>>, /// Path containing the `Cargo.toml` pub manifest_path: String, } #[derive(Clone, Deserialize, Debug)] /// A single target (lib, bin, example, ...) provided by a crate pub struct Target { /// Name as given in the `Cargo.toml` or generated from the file name pub name: String, /// Kind of target ("bin", "example", "test", "bench", "lib") pub kind: Vec<String>, /// Almost the same as `kind`, except when an example is a library instad of an executable. /// In that case `crate_types` contains things like `rlib` and `dylib` while `kind` is `example` #[serde(default)] pub crate_types: Vec<String>, /// Path to the main source file of the target pub src_path: String, } mod errors { //! Create the `Error`, `ErrorKind`, `ResultExt`, and `Result` types error_chain!{ foreign_links { // Error during execution of `cargo metadata` Io(::std::io::Error); // Output of `cargo metadata` was not valid utf8 Utf8(::std::str::Utf8Error); // Deserialization error (structure of json did not match expected structure) Json(::serde_json::Error); } } } /// Obtain metadata only about the root package and don't fetch dependencies /// /// # Parameters /// /// - `manifest_path`: Path to the manifest. pub fn metadata(manifest_path: Option<&Path>) -> Result<Metadata> { metadata_deps(manifest_path, false) } /// The main entry point to obtaining metadata /// /// # Parameters /// /// - `manifest_path`: Path to the manifest. /// - `deps`: Whether to include dependencies. pub fn metadata_deps(manifest_path: Option<&Path>, deps: bool) -> Result<Metadata> { let cargo = env::var("CARGO").unwrap_or_else(|_| String::from("cargo")); let mut cmd = Command::new(cargo); cmd.arg("metadata"); if !deps { cmd.arg("--no-deps"); } cmd.args(&["--format-version", "1"]); if let Some(manifest_path) = manifest_path { cmd.arg("--manifest-path").arg(manifest_path.as_os_str()); } let output = cmd.output()?; let stdout = from_utf8(&output.stdout)?; let meta = serde_json::from_str(stdout)?; Ok(meta) }