# I/O Process [![Documentation](https://img.shields.io/docsrs/io-process)](https://docs.rs/io-process/latest/io_process) [![Matrix](https://img.shields.io/matrix/pimalaya:matrix.org?color=success&label=chat)](https://matrix.to/#/#pimalaya:matrix.org)

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](https://github.com/pimalaya/io-process/tree/master/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](https://github.com/pimalaya/io-process/tree/master/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](https://github.com/pimalaya/io-process/blob/master/examples).*

### Spawn std blocking command

```rust,ignore
use io_process::{
    coroutines::spawn_then_wait::{SpawnThenWaitResult, SpawnThenWait},
    runtimes::std::handle,
    command::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()) {
        SpawnThenWaitResult::Ok(status) => break status,
        SpawnThenWaitResult::Io(io) => arg = Some(handle(io).unwrap()),
        SpawnThenWaitResult::Err(err) => panic!("{err}"),
    }
}
```

### Spawn tokio async command then wait for output

```rust,ignore
use io_process::{
    coroutines::spawn_then_wait_with_output::{
	SpawnThenWaitWithOutputResult,
        SpawnThenWaitWithOutput,
    },
    runtimes::std::handle,
    command::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()) {
        SpawnThenWaitWithOutputResult::Ok(status) => break status,
        SpawnThenWaitWithOutputResult::Io(io) => arg = Some(handle(io).await.unwrap()),
        SpawnThenWaitWithOutputResult::Err(err) => panic!("{err}"),
    }
}
```

### More examples

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

- [Comodoro](https://github.com/pimalaya/comodoro): CLI to manage timers
- [Ortie](https://github.com/pimalaya/ortie): CLI to manage OAuth access tokens

## License

This project is licensed under either of:

- [MIT license](LICENSE-MIT)
- [Apache License, Version 2.0](LICENSE-APACHE)

at your option.

## Sponsoring

[![nlnet](https://nlnet.nl/logo/banner-160x60.png)](https://nlnet.nl/)

Special thanks to the [NLnet foundation](https://nlnet.nl/) and the [European Commission](https://www.ngi.eu/) that helped the project to receive financial support from various programs:

- [NGI Assure](https://nlnet.nl/project/Himalaya/) in 2022
- [NGI Zero Entrust](https://nlnet.nl/project/Pimalaya/) in 2023
- [NGI Zero Core](https://nlnet.nl/project/Pimalaya-PIM/) in 2024 *(still ongoing)*

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

[![GitHub](https://img.shields.io/badge/-GitHub%20Sponsors-fafbfc?logo=GitHub%20Sponsors)](https://github.com/sponsors/soywod)
[![Ko-fi](https://img.shields.io/badge/-Ko--fi-ff5e5a?logo=Ko-fi&logoColor=ffffff)](https://ko-fi.com/soywod)
[![Buy Me a Coffee](https://img.shields.io/badge/-Buy%20Me%20a%20Coffee-ffdd00?logo=Buy%20Me%20A%20Coffee&logoColor=000000)](https://www.buymeacoffee.com/soywod)
[![Liberapay](https://img.shields.io/badge/-Liberapay-f6c915?logo=Liberapay&logoColor=222222)](https://liberapay.com/soywod)
[![thanks.dev](https://img.shields.io/badge/-thanks.dev-000000?logo=data:image/svg+xml;base64, )](https://thanks.dev/soywod)
[![PayPal](https://img.shields.io/badge/-PayPal-0079c1?logo=PayPal&logoColor=ffffff)](https://www.paypal.com/paypalme/soywod)
