Struct Process 

pub struct Process(/* private fields */);

A handle to a running or finished subprocess.

Process is a lightweight handle that tracks a child process’s lifecycle. It is created internally by Exec::start and Pipeline::start and appears as part of the Job struct.

Unlike std::process::Child, all methods on Process take &self rather than &mut self, so a Process can be shared between threads without external synchronization.

Process is cheaply cloneable. Clones share the same underlying process handle, so e.g. calling wait() on one clone will also make the exit status available to all other clones.

Drop behavior

When the last clone of a Process is dropped, it waits for the child process to finish unless detach has been called. Because Process does not own any pipes to the child, callers must ensure that any pipes connected to the child’s stdin are dropped before the Process is dropped. Otherwise, the child may block waiting for input while the Process drop waits for the child to exit, resulting in a deadlock. Job handles this automatically via field declaration order.

Implementations

impl Process

pub fn pid(&self) -> u32

Returns the PID of the subprocess.

pub fn exit_status(&self) -> Option<ExitStatus>

Returns the exit status, if the process is known to have finished.

This does not perform any system calls. To check whether the process has finished, use poll or wait.

pub fn poll(&self) -> Option<ExitStatus>

Check whether the process has finished, without blocking.

Returns Some(exit_status) if the process has finished, None if it is still running.

pub fn wait(&self) -> Result<ExitStatus>

Wait for the process to finish and return its exit status.

If the process has already finished, returns the cached exit status immediately.

pub fn wait_timeout(&self, dur: Duration) -> Result<Option<ExitStatus>>

Wait for the process to finish, timing out after the specified duration.

Returns Ok(None) if the timeout elapsed before the process finished.

pub fn terminate(&self) -> Result<()>

Terminate the subprocess.

On Unix, this sends SIGTERM. On Windows, this calls TerminateProcess.

If the process has already been reaped, this is a no-op to avoid signaling a potentially reused PID.

pub fn kill(&self) -> Result<()>

Kill the subprocess.

On Unix, this sends SIGKILL. On Windows, this calls TerminateProcess.

If the process has already been reaped, this is a no-op to avoid signaling a potentially reused PID.

pub fn detach(&self)

Mark the process as detached.

A detached process will not be waited on when the Process is dropped.

Trait Implementations

impl Clone for Process

fn clone(&self) -> Process

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Process

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

Formats the value using the given formatter.

impl ProcessExt for Process

fn send_signal(&self, signal: i32) -> Result<()>

Send the specified signal to the child process.

fn send_signal_group(&self, signal: i32) -> Result<()>

Send the specified signal to the child’s process group.