Crate io_keyring

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.

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.

Read secret from entry synchronously

use io_keyring::{coroutines::Read, handlers::std::handle};

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

let mut arg = None;
let mut read = Read::new(entry.clone());

let secret = loop {
    match read.resume(arg) {
        Ok(secret) => break secret,
        Err(io) => arg = Some(handle(io).unwrap()),
    }
};

Write secret into entry synchronously

use io_keyring::{coroutines::Write, handlers::std::handle};

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

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

while let Err(io) = write.resume(arg) {
    arg = Some(handle(io).unwrap());
}

Delete secret from entry synchronously

use io_keyring::{coroutines::Delete, handlers::std::handle};

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

let mut arg = None;
let mut Delete = Delete::new(entry);

while let Err(io) = delete.resume(arg) {
    arg = Some(handle(io).unwrap());
}

More examples

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

• TODO

Sponsoring

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:

Modules

coroutines

Module gathering I/O-free, composable and iterable state machines.

runtimes

Collection of stream I/O handlers.

serdeserde

Module dedicated to serde de/serialization of Entry.

Structs

Entry

Enums

Io

The keyring I/O request enum, emitted by coroutines and processed by runtimes.