Struct escargot::CargoBuild

pub struct CargoBuild { /* fields omitted */ }

The build subcommand.

Example

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();

Methods

impl CargoBuild

pub fn new() -> Self

Shortcut to create a build subcommand.

See also Cargo.

Example

extern crate escargot;
extern crate assert_fs;

let temp = assert_fs::TempDir::new().unwrap();
escargot::CargoBuild::new()
    .bin("bin")
    .manifest_path("tests/fixtures/bin/Cargo.toml")
    .target_dir(temp.path())
    .exec()
    .unwrap();

pub fn package<S: AsRef<OsStr>>(self, name: S) -> Self

Build from name package in workspaces.

Example

extern crate escargot;
extern crate assert_fs;

let temp = assert_fs::TempDir::new().unwrap();
escargot::CargoBuild::new()
    .package("bin")
    .bin("bin")
    .manifest_path("tests/fixtures/bin/Cargo.toml")
    .target_dir(temp.path())
    .exec()
    .unwrap();

pub fn bin<S: AsRef<OsStr>>(self, name: S) -> Self

Build only name binary.

Example

extern crate escargot;
extern crate assert_fs;

let temp = assert_fs::TempDir::new().unwrap();
escargot::CargoBuild::new()
    .bin("bin")
    .manifest_path("tests/fixtures/bin/Cargo.toml")
    .target_dir(temp.path())
    .exec()
    .unwrap();

pub fn example<S: AsRef<OsStr>>(self, name: S) -> Self

Build only name example.

Example

extern crate escargot;
extern crate assert_fs;

let temp = assert_fs::TempDir::new().unwrap();
escargot::CargoBuild::new()
    .example("example_fixture")
    .manifest_path("tests/fixtures/example/Cargo.toml")
    .target_dir(temp.path())
    .exec()
    .unwrap();

pub fn tests(self) -> Self

Build all tests

Example

extern crate escargot;
extern crate assert_fs;

let temp = assert_fs::TempDir::new().unwrap();
escargot::CargoBuild::new()
    .tests()
    .manifest_path("tests/fixtures/test/Cargo.toml")
    .target_dir(temp.path())
    .exec()
    .unwrap();

pub fn test<S: AsRef<OsStr>>(self, name: S) -> Self

Build only name test.

Example

extern crate escargot;
extern crate assert_fs;

let temp = assert_fs::TempDir::new().unwrap();
escargot::CargoBuild::new()
    .test("test")
    .manifest_path("tests/fixtures/test/Cargo.toml")
    .target_dir(temp.path())
    .exec()
    .unwrap();

pub fn manifest_path<S: AsRef<OsStr>>(self, path: S) -> Self

Path to Cargo.toml

pub fn release(self) -> Self

Build artifacts in release mode, with optimizations.

pub fn current_release(self) -> Self

Build artifacts in release mode if the current process has, with optimizations.

pub fn target<S: AsRef<OsStr>>(self, triplet: S) -> Self

Build for the target triplet.

pub fn current_target(self) -> Self

Build for the current process' triplet.

pub fn target_dir<S: AsRef<OsStr>>(self, dir: S) -> Self

Directory for all generated artifacts

pub fn all_features(self) -> Self

Activate all available features

pub fn no_default_features(self) -> Self

Do not activate the default feature

pub fn features<S: AsRef<OsStr>>(self, features: S) -> Self

Space-separated list of features to activate

pub fn arg<S: AsRef<OsStr>>(self, arg: S) -> Self

Manually pass an argument that is unsupported.

Caution: Passing in -- can throw off the API.

pub fn exec(self) -> CargoResult<CommandMessages>

Build the configured target, returning compiler messages.

pub fn run(self) -> CargoResult<CargoRun>

Provide a proxy for running the built target.

Example

extern crate escargot;
extern crate assert_fs;

let temp = assert_fs::TempDir::new().unwrap();
let run = escargot::CargoBuild::new()
    .bin("bin")
    .current_release()
    .current_target()
    .manifest_path("tests/fixtures/bin/Cargo.toml")
    .target_dir(temp.path())
    .run()
    .unwrap();
println!("artifact={}", run.path().display());

pub fn run_tests(
    self
) -> CargoResult<impl Iterator<Item = Result<CargoTest, CargoError>>>

Provide a proxy for running the built target.

Required feature: test_unstable since the format parsed is unstable.

Example

extern crate escargot;
extern crate assert_fs;

let temp = assert_fs::TempDir::new().unwrap();
let run = escargot::CargoBuild::new()
    .test("test")
    .current_release()
    .current_target()
    .manifest_path("tests/fixtures/test/Cargo.toml")
    .target_dir(temp.path())
    .run_tests().unwrap()
    .next().unwrap().unwrap();
println!("artifact={}", run.path().display());

Trait Implementations

impl Default for CargoBuild

fn default() -> Self

Returns the "default value" for a type.