Struct CargoBuilder

pub struct CargoBuilder { /* private fields */ }

A builder-pattern which constructs a command to invoke cargo build

Implementations

impl CargoBuilder

pub fn new(env: &Environment, working_dir: &Path, clean_env: bool) -> Self

Construct a new builder instance to run cargo in the given directory.

If clean_env is set, cargo configuration variables will not be passed through from the command.

pub fn construct(&mut self) -> Command

Constructs the command which will execute cargo

pub fn cargo_path(&mut self, cargo: &Path) -> &mut Self

Set the path to the cargo executable

pub fn home(&mut self, home: &Path) -> &mut Self

Set the CARGO_HOME variable for invoking cargo

pub fn target_dir(&mut self, target_dir: &Path) -> &mut Self

Set the CARGO_TARGET_DIR variable for invoking cargo

pub fn rustc(&mut self, rustc: &Path) -> &mut Self

Set the RUSTC variable for invoking cargo

pub fn rustc_wrapper(&mut self, rustc_wrapper: &Path) -> &mut Self

Set the RUSTC_WRAPPER variable for invoking cargo

pub fn rustdoc(&mut self, rustdoc: &Path) -> &mut Self

Set the RUSTDOC variable when invoking cargo

pub fn add_rustdoc_flag(&mut self, rustdoc_flag: &str) -> &mut Self

Add an item to the RUSTDOCFLAGS environment string

pub fn add_rustdoc_flags(&mut self, rustdoc_flags: &[&str]) -> &mut Self

Add multiple items to the RUSTDOCFLAGS environment string

pub fn add_rust_flag(&mut self, rust_flag: &str) -> &mut Self

Add an item to the RUSTFLAGS environment string

pub fn add_rust_flags(&mut self, rust_flags: &[&str]) -> &mut Self

Add multiple items to the RUSTFLAGS environment string

pub fn incremental(&mut self, incremental: bool) -> &mut Self

Explicitly set whether incremental builds are enabled or disabled

pub fn cache_rustc_info(&mut self, cache_rustc_info: bool) -> &mut Self

Enable/disable whether or not cargo should cache rust info

pub fn term(&mut self, term: &str) -> &mut Self

Set the terminal environment variable.

pub fn build_jobs(&mut self, build_jobs: u64) -> &mut Self

Override the build.jobs configuration option

pub fn target(&mut self, target: &str) -> &mut Self

Override the build.target configuration option

pub fn dep_info_basedir(&mut self, dep_info_basedir: &Path) -> &mut Self

Override the build.dep-info-basedir configuration option

pub fn pipelining(&mut self, pipelining: bool) -> &mut Self

Override the build.pipelining configuration option

pub fn http_debug(&mut self, http_debug: bool) -> &mut Self

Override the http.debug configuration option

pub fn http_proxy(&mut self, http_proxy: &str) -> &mut Self

Override the http.proxy configuration option

pub fn http_timeout(&mut self, http_timeout: Duration) -> &mut Self

Override the http.debug configuration option

pub fn http_cainfo(&mut self, http_cainfo: &Path) -> &mut Self

Override the http.cainfo file configuration option

pub fn http_check_revoke(&mut self, http_check_revoke: bool) -> &mut Self

Override the http.check-revoke configuration option

pub fn http_ssl_version(&mut self, http_ssl_version: &str) -> &mut Self

Override the http.ssl-version configuration option

pub fn http_low_speed_limit(&mut self, http_low_speed_limit: u64) -> &mut Self

Override the http.low-speed-limit configuration option

pub fn http_multiplexing(&mut self, http_multiplexing: bool) -> &mut Self

Override the http.multiplexing configuration option

pub fn http_user_agent(&mut self, http_user_agent: String) -> &mut Self

Override the http.user-agent configuration option

pub fn net_retry(&mut self, net_retry: u64) -> &mut Self

Override the net.retry configuration option

pub fn net_git_fetch_with_cli( &mut self, net_git_fetch_with_cli: bool, ) -> &mut Self

Override the net.get_fetch_with_cli configuration option

pub fn net_offline(&mut self, net_offline: bool) -> &mut Self

Override the net.offline configuration option

pub fn add_registry(&mut self, name: String, index: Url) -> &mut Self

Add a new crates.io-style registry to this invocation of cargo

pub fn term_verbose(&mut self, term_verbose: bool) -> &mut Self

Sets whether to use verbose stdout in the cargo run

pub fn term_color(&mut self, term_color: bool) -> &mut Self

Sets whether to output terminal colors

pub fn profile(&mut self, profile: String) -> &mut Self

Override the inherited profile (i.e. --release)

pub fn locked(&mut self, locked: bool) -> &mut Self

Override the inherited locked argument (i.e. --locked)

Trait Implementations

impl Clone for CargoBuilder

fn clone(&self) -> CargoBuilder

Returns a duplicate of the value.

const fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CargoBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.