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:
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.
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.
The loop is the glue between coroutines and runtimes. It makes the coroutine progress while allowing runtime to process I/O.
See complete examples at ./examples.
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}"),
}
}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}"),
}
}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}"),
}
}Have a look at projects built on the top of this library:
- Ortie: CLI to manage OAuth access tokens
This project is licensed under either of:
at your option.
Special thanks to the NLnet foundation and the European Commission that helped the project to receive financial support from various programs:
- NGI Assure in 2022
- NGI Zero Entrust in 2023
- NGI Zero Core in 2024 (still ongoing)
If you appreciate the project, feel free to donate using one of the following providers:
