io-keyring

Crates.io	io-keyring
lib.rs	io-keyring
version	0.0.2
created_at	2025-06-04 08:58:35.846521+00
updated_at	2025-09-11 08:54:48.187383+00
description	Set of I/O-free Rust coroutines and runtimes to manage keyring entries
homepage	https://pimalaya.org
repository	https://github.com/pimalaya/io-keyring
max_upload_size
id	1699982
size	88,919

Clément DOUIN (soywod)

documentation

https://docs.rs/io-keyring/latest/io_keyring

README

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::{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

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

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}"),
    }
}