summaryrefslogtreecommitdiffstats
path: root/vendor/escargot/src/lib.rs
blob: dd6559131590b5b7b62848fc16e79e3f38dd5a65 (plain)
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
//! # 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)]
#![cfg_attr(docsrs, feature(doc_auto_cfg))]

#[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;