Struct BootstrapCommand 

pub(crate) struct BootstrapCommand {
    command: Command,
    pub(crate) failure_behavior: BehaviorOnFailure,
    pub(crate) run_in_dry_run: bool,
    drop_bomb: DropBomb,
    should_cache: bool,
}

Wrapper around std::process::Command.

By default, the command will exit bootstrap if it fails. If you want to allow failures, use allow_failure. If you want to delay failures until the end of bootstrap, use delay_failure.

By default, the command will print its stdout/stderr to stdout/stderr of bootstrap (OutputMode::Print). If you want to handle the output programmatically, use BootstrapCommand::run_capture.

Bootstrap will print a debug log to stdout if the command fails and failure is not allowed.

By default, command executions are cached based on their workdir, program, arguments, and environment variables. This avoids re-running identical commands unnecessarily, unless caching is explicitly disabled.

Fields

command: Command

failure_behavior: BehaviorOnFailure

run_in_dry_run: bool

drop_bomb: DropBomb

should_cache: bool

Implementations

impl<'a> BootstrapCommand

pub(crate) fn new<S: AsRef<OsStr>>(program: S) -> Self

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

pub(crate) fn cached(&mut self) -> &mut Self

Cache the command. If it will be executed multiple times with the exact same arguments and environment variables in the same bootstrap invocation, the previous result will be loaded from memory.

pub(crate) fn args<I, S>(&mut self, args: I) -> &mut Self

where I: IntoIterator<Item = S>, S: AsRef<OsStr>,

pub(crate) fn env<K, V>(&mut self, key: K, val: V) -> &mut Self

where K: AsRef<OsStr>, V: AsRef<OsStr>,

pub(crate) fn get_envs(&self) -> CommandEnvs<'_>

pub(crate) fn get_args(&self) -> CommandArgs<'_>

pub(crate) fn env_remove<K: AsRef<OsStr>>(&mut self, key: K) -> &mut Self

pub(crate) fn current_dir<P: AsRef<Path>>(&mut self, dir: P) -> &mut Self

pub(crate) fn stdin(&mut self, stdin: Stdio) -> &mut Self

pub(crate) fn delay_failure(self) -> Self

pub(crate) fn fail_fast(self) -> Self

pub(crate) fn allow_failure(self) -> Self

pub(crate) fn run_in_dry_run(&mut self) -> &mut Self

pub(crate) fn run(&mut self, exec_ctx: impl AsRef<ExecutionContext>) -> bool

Run the command, while printing stdout and stderr. Returns true if the command has succeeded.

pub(crate) fn run_capture( &mut self, exec_ctx: impl AsRef<ExecutionContext>, ) -> CommandOutput

Run the command, while capturing and returning all its output.

pub(crate) fn run_capture_stdout( &mut self, exec_ctx: impl AsRef<ExecutionContext>, ) -> CommandOutput

Run the command, while capturing and returning stdout, and printing stderr.

pub(crate) fn start_capture( &'a mut self, exec_ctx: impl AsRef<ExecutionContext>, ) -> DeferredCommand<'a>

Spawn the command in background, while capturing and returning all its output.

pub(crate) fn start_capture_stdout( &'a mut self, exec_ctx: impl AsRef<ExecutionContext>, ) -> DeferredCommand<'a>

Spawn the command in background, while capturing and returning stdout, and printing stderr.

pub(crate) fn stream_capture_stdout( &'a mut self, exec_ctx: impl AsRef<ExecutionContext>, ) -> Option<StreamingCommand>

Spawn the command in background, while capturing and returning stdout, and printing stderr. Returns None in dry-mode

pub(crate) fn mark_as_executed(&mut self)

Mark the command as being executed, disarming the drop bomb. If this method is not called before the command is dropped, its drop will panic.

pub(crate) fn get_created_location(&self) -> Location<'static>

Returns the source code location where this command was created.

pub(crate) fn fingerprint(&self) -> CommandFingerprint

Trait Implementations

impl Debug for BootstrapCommand

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

Formats the value using the given formatter.

impl From<Cargo> for BootstrapCommand

fn from(cargo: Cargo) -> BootstrapCommand

Converts to this type from the input type.

impl From<Command> for BootstrapCommand

fn from(command: Command) -> Self

Converts to this type from the input type.

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 264 bytes