Struct CommandProcess

pub struct CommandProcess {
    pub environment: HashMap<String, String>,
    pub step: XvcStep,
    pub step_command: XvcStepCommand,
    pub birth: Option<Instant>,
    pub process: Option<Popen>,
    pub stdout_sender: Sender<String>,
    pub stderr_sender: Sender<String>,
    pub stdout_receiver: Receiver<String>,
    pub stderr_receiver: Receiver<String>,
}

Used for encapsulating a process and its outputs. This is used to associate steps with running processes.

Fields

environment: HashMap<String, String>

Environment variables injected to the shell that runs the command. This is used to pass added, removed items in certain dependency types.

step: XvcStep

The step that this command belongs to

step_command: XvcStepCommand

The command to run

birth: Option<Instant>

When we started running the command

process: Option<Popen>

The process that runs the command

stdout_sender: Sender<String>

Channel to send stdout to

stderr_sender: Sender<String>

Channel to send stderr to

stdout_receiver: Receiver<String>

Channel to receive stdout from

stderr_receiver: Receiver<String>

Channel to receive stderr from

Implementations

impl CommandProcess

pub fn new(step: &XvcStep, step_command: &XvcStepCommand) -> Self

Create a new CommandProcess by creating channels and setting other variables to their default values.

pub fn add_environment_variable( &mut self, key: &str, value: &str, ) -> Result<&mut Self>

Add an environment variable to inject to the shell that runs the command.

pub fn run(&mut self) -> Result<()>

Start executing the command in a shell. Updates birth and process variables after detaching.

pub fn update_output_channels(&mut self) -> Result<()>

Collects the output from process and sends to output channels.

Trait Implementations

impl Debug for CommandProcess

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

Formats the value using the given formatter.