blob: f802eca85bc8148a12bf4b13b99de56548ba052d [file] [log] [blame] [edit]
//! # Escargot: A Cargo API
//!
//! ## Features
//!
//! Features:
//! - `print` for logged output to be printed instead, generally for test writing.
//!
//! ## Why escargot
//!
//! Compared to depending on `cargo`:
//! - Faster compile times.
//! - Simpler API.
//! - Better interop with projects relying on other cargo versions.
//! - Probably slower execution, especially on platforms without an optimized `fork` (e.g. Windows).
//!
//! ## Relevant crates
//!
//! Other related crates:
//! * [cargo](https://crates.io/crates/cargo) for the real thing
//! * [cargo-metadata](https://crates.io/crates/cargo_metadata) for a similar project specifically geared to the `metadata` subcommand.
//!
//! # Example
//!
//! ```rust
//! extern crate escargot;
//! extern crate assert_fs;
//!
//! let temp = assert_fs::TempDir::new().unwrap();
//! escargot::CargoBuild::new()
//! .bin("bin")
//! .current_release()
//! .current_target()
//! .manifest_path("tests/fixtures/bin/Cargo.toml")
//! .target_dir(temp.path())
//! .exec()
//! .unwrap();
//! ```
#![warn(missing_docs)]
#[macro_use]
extern crate serde;
mod build;
pub use crate::build::*;
mod cargo;
pub use crate::cargo::*;
mod msg;
pub use crate::msg::*;
mod run;
pub use crate::run::*;
#[cfg(feature = "test_unstable")]
mod test;
#[cfg(feature = "test_unstable")]
pub use test::*;
pub mod error;
pub mod format;