Struct Child 

pub struct Child {
    pub stdin: Option<ChildStdin>,
    pub stdout: Option<ChildStdout>,
    pub stderr: Option<ChildStderr>,
    /* private fields */
}

A spawned child process.

Fields

stdin: Option<ChildStdin>

The child’s stdin, if piped.

stdout: Option<ChildStdout>

The child’s stdout, if piped.

stderr: Option<ChildStderr>

The child’s stderr, if piped.

Implementations

impl Child

pub fn id(&self) -> u32

The child’s process id.

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

Waits for the child’s exit. Its stdin, if piped, is closed first, so a child that reads it to its end can exit.

Errors

When the exit cannot be watched, or the child was reaped by something else (ECHILD: SIGCHLD ignored, or a waitpid of the program’s own).

pub fn try_wait(&mut self) -> Result<Option<ExitStatus>>

The child’s status if it exited, else None, without waiting.

Errors

When the child’s state cannot be read.

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

Starts ending the child, without waiting for it to go: SIGKILL on unix, TerminateProcess on Windows. A child that exited already is left alone.

Errors

When the signal or the call fails.

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

Ends the child, as start_kill does, and waits for its exit.

use nuclei::process::Command;

let mut child = Command::new("sleep").arg("60").spawn()?;
child.kill().await?;
assert!(child.try_wait()?.is_some());

Errors

As for start_kill and wait.

pub async fn wait_with_output(self) -> Result<Output>

Waits for the child’s exit, collecting its stdout and stderr (those piped) until then. Its stdin, if piped, is closed first.

Errors

As for wait, and when a pipe cannot be read.

Trait Implementations

impl Debug for Child

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

Formats the value using the given formatter.

impl Drop for Child

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.