# I/O Keyring

Set of **I/O-free** Rust coroutines and runtimes to manage keyring entries.

This library allows you to manage keyring entries 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-keyring/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-keyring/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-keyring/blob/master/examples).*

### Read secret from entry synchronously

```rust,ignore
use io_keyring::{
    coroutines::read::{ReadSecret, ReadSecretResult},
    entry::KeyringEntry,
    handlers::std::handle,
};

let entry = KeyringEntry::new("name").with_service("example");

let mut arg = None;
let mut read = ReadSecret::new(entry);

let secret = loop {
    match read.resume(arg.take()) {
        ReadSecretResult::Ok(secret) => break secret,
        ReadSecretResult::Io(io) => arg = Some(handle(io).unwrap()),
        ReadSecretResult::Err(err) => panic!("{err}"),
    }
}
```

### Write secret into entry synchronously

```rust,ignore
use io_keyring::{
    coroutines::write::{WriteSecret, WriteSecretResult},
    entry::KeyringEntry,
    handlers::std::handle,
};

let entry = KeyringEntry::new("name").with_service("example");

let mut arg = None;
let mut write = WriteSecret::new(entry, "password");

loop {
    match write.resume(arg.take()) {
        WriteSecretResult::Ok(()) => break,
        WriteSecretResult::Io(io) => arg = Some(handle(io).unwrap()),
        WriteSecretResult::Err(err) => panic!("{err}"),
    }
}
```

### Delete secret from entry synchronously

```rust,ignore
use io_keyring::{
    coroutines::delete::{DeleteSecret, DeleteSecretResult},
    entry::KeyringEntry,
    handlers::std::handle,
};

let entry = Entry::new("name").service("example");

let mut arg = None;
let mut delete = DeleteSecret::new(entry);

loop {
    match delete.resume(arg.take()) {
        DeleteSecretResult::Ok(()) => break,
        DeleteSecretResult::Io(io) => arg = Some(handle(io).unwrap()),
        DeleteSecretResult::Err(err) => panic!("{err}"),
    }
}
```

### More examples

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

- [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

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://github.com/sponsors/soywod)
- [Ko-fi](https://ko-fi.com/soywod)
- [Buy Me a Coffee](https://www.buymeacoffee.com/soywod)
- [Liberapay](https://liberapay.com/soywod)
- [thanks.dev](https://thanks.dev/soywod)
- [PayPal](https://www.paypal.com/paypalme/soywod)
