Expand description

Async interface for working with processes.

This crate is an async version of std::process.

Implementation

A background thread named “async-process” is lazily created on first use, which waits for spawned child processes to exit and then calls the wait() syscall to clean up the “zombie” processes. This is unlike the process API in the standard library, where dropping a running Child leaks its resources.

This crate uses async-io for async I/O on Unix-like systems and blocking for async I/O on Windows.

Examples

Spawn a process and collect its output:

use async_process::Command;

let out = Command::new("echo").arg("hello").arg("world").output().await?;
assert_eq!(out.stdout, b"hello world\n");

Read the output line-by-line as it gets produced:

use async_process::{Command, Stdio};
use futures_lite::{io::BufReader, prelude::*};

let mut child = Command::new("find")
    .arg(".")
    .stdout(Stdio::piped())
    .spawn()?;

let mut lines = BufReader::new(child.stdout.take().unwrap()).lines();

while let Some(line) = lines.next().await {
    println!("{}", line?);
}

Modules

Unix-specific extensions.

Structs

A spawned child process.

A handle to a child process’s standard error (stderr).

A handle to a child process’s standard input (stdin).

A handle to a child process’s standard output (stdout).

A builder for spawning processes.

Describes the result of a process after it has terminated.

The output of a finished process.

Describes what to do with a standard I/O stream for a child process when passed to the stdin, stdout, and stderr methods of Command.