Struct ChildProcess 

pub struct ChildProcess { /* private fields */ }

A child process this agent started.

04-subsystem-contracts.md: “local process state is authoritative only for a child process owned by this agent”. That is this type. For a process recovered from the journal after a restart there is no Child and no parent relationship, so ProcessIdentity is the authority instead.

Implementations

impl ChildProcess

pub const fn identity(&self) -> &ProcessIdentity

The identity to record in the journal.

pub const fn pid(&self) -> u32

The child’s PID.

pub fn is_running(&mut self) -> Result<bool, ProcessError>

Whether the child is still running.

Errors

ProcessError::Control when the wait fails.

pub fn try_exit_status(&mut self) -> Result<Option<ExitStatus>, ProcessError>

The child’s exit status if it has already exited, reaping it if so.

Errors

ProcessError::Control when the wait fails.

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

Blocks until the child exits.

Errors

ProcessError::Control when the wait fails.

pub fn wait_for( &mut self, timeout: Duration, ) -> Result<Option<ExitStatus>, ProcessError>

Waits up to timeout for the child to exit; None means it is still running when the timeout expires.

Errors

ProcessError::Control when the wait fails.

pub fn stop(&mut self, grace: Duration) -> Result<ExitStatus, ProcessError>

Asks the child to stop, forcefully if grace expires first.

See ProcessIdentity::terminate for what grace means on each platform. Unlike that method this one has the parent relationship, so it reaps the child and returns its exit status.

Errors

ProcessError::Control when signalling or waiting fails.

pub fn take_stdout(&mut self) -> Option<ChildStdout>

Takes the captured standard output, if OutputMode::Capture was set.

pub fn take_stderr(&mut self) -> Option<ChildStderr>

Takes the captured standard error, if OutputMode::Capture was set.

pub fn program(&self) -> &Path

The program that was launched.

Trait Implementations

impl Debug for ChildProcess

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

Formats the value using the given formatter.