Struct CargoCommandBuilder

pub struct CargoCommandBuilder {

    pub manifest_path: PathBuf,
    pub args: Vec<String>,
    pub subcommand: String,
    pub pid: Option<u32>,
    pub alternate_cmd: Option<String>,
    pub execution_dir: Option<PathBuf>,
    pub suppressed_flags: HashSet<String>,
    pub stdout_dispatcher: Option<Arc<EventDispatcher>>,
    pub stderr_dispatcher: Option<Arc<EventDispatcher>>,
    pub progress_dispatcher: Option<Arc<EventDispatcher>>,
    pub stage_dispatcher: Option<Arc<EventDispatcher>>,
    pub terminal_error_flag: Arc<Mutex<bool>>,
    pub sender: Option<Arc<Mutex<Sender<TerminalError>>>>,
    pub diagnostics: Arc<Mutex<Vec<CargoDiagnostic>>>,
    pub is_filter: bool,
}

A builder that constructs a Cargo command for a given target.

Fields

manifest_path: PathBuf

args: Vec<String>

subcommand: String

pid: Option<u32>

alternate_cmd: Option<String>

execution_dir: Option<PathBuf>

suppressed_flags: HashSet<String>

stdout_dispatcher: Option<Arc<EventDispatcher>>

stderr_dispatcher: Option<Arc<EventDispatcher>>

progress_dispatcher: Option<Arc<EventDispatcher>>

stage_dispatcher: Option<Arc<EventDispatcher>>

terminal_error_flag: Arc<Mutex<bool>>

sender: Option<Arc<Mutex<Sender<TerminalError>>>>

diagnostics: Arc<Mutex<Vec<CargoDiagnostic>>>

is_filter: bool

Implementations

impl CargoCommandBuilder

pub fn new(manifest: &PathBuf, subcommand: &str, is_filter: bool) -> Self

Creates a new, empty builder.

pub fn run<F>(self: Arc<Self>, on_spawn: F) -> Result<u32>

where F: FnOnce(u32, CargoProcessHandle),

pub fn wait(self: Arc<Self>, pid: Option<u32>) -> Result<CargoProcessResult>

pub fn with_target(self, target: &CargoTarget) -> Self

Configure the command based on the target kind.

pub fn with_cli(self, cli: &Cli) -> Self

Configure the command using CLI options.

pub fn with_required_features( self, manifest: &PathBuf, target: &CargoTarget, ) -> Self

Append required features based on the manifest, target kind, and name. This method queries your manifest helper function and, if features are found, appends “–features” and the feature list.

pub fn with_extra_args(self, extra: &[String]) -> Self

Appends extra arguments to the command.

pub fn build(self) -> Vec<String>

Builds the final vector of command-line arguments.

pub fn build_command(&self) -> Command

Optionally, builds a std::process::Command.

Trait Implementations

impl Clone for CargoCommandBuilder

fn clone(&self) -> CargoCommandBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for CargoCommandBuilder

fn default() -> Self

Returns the “default value” for a type.