Crate io_process

Source
Expand description

§I/O Process Documentation Matrix

Set of I/O-free Rust coroutines and runtimes to manage processes.

This library allows you to manage processes using an I/O-agnostic approach, based on 3 concepts:

§Coroutine

A coroutine is an I/O-free, resumable and composable state machine that emits I/O requests. A coroutine is considered terminated when it does not emit I/O requests anymore.

See available coroutines at ./src/coroutines.

§Runtime

A runtime contains all the I/O logic, and is responsible for processing I/O requests emitted by coroutines.

See available runtimes at ./src/runtimes.

§Loop

The loop is the glue between coroutines and runtimes. It makes the coroutine progress while allowing runtime to process I/O.

§Examples

See complete examples at ./examples.

§Spawn std blocking command

use io_process::{coroutines::SpawnThenWait, runtimes::std::handle, Command};

let mut command = Command::new("ls");
command.arg("-al");
command.arg("/tmp");

let mut arg = None;
let mut spawn = SpawnThenWait::new(command);

let status = loop {
    match spawn.resume(arg.take()) {
        Ok(status) => break status,
        Err(io) => arg = Some(handle(&mut spawn, io).unwrap()),
    }
}

§Spawn tokio async command then wait for output

use io_process::{coroutines::SpawnThenWaitWithOutput, runtimes::tokio::handle, Command};

let mut command = Command::new("ls");
command.arg("-al");
command.arg("/tmp");

let mut arg = None;
let mut spawn = SpawnThenWaitWithOutput::new(command);

let output = loop {
    match spawn.resume(arg.take()) {
        Ok(output) => break output,
        Err(io) => arg = Some(handle(&mut spawn, io).await.unwrap()),
    }
}

§More examples

Have a look at projects built on the top of this library:

§Sponsoring

nlnet

Special thanks to the NLnet foundation and the European Commission that helped the project to receive financial support from various programs:

If you appreciate the project, feel free to donate using one of the following providers:

GitHub Ko-fi Buy Me a Coffee Liberapay thanks.dev PayPal

Modules§

coroutines
Module gathering I/O-free, composable and iterable state machines.
runtimes
Collection of process I/O handlers.

Structs§

Command
The command builder.
SpawnOutput

Enums§

Io