Set of I/O-free Rust coroutines to manage Vdir filesystems, based on io-fs.
This library allows you to manage vCard files (.vcf) and iCal (.ics) files inside Vdir filesystems 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 io-fs.
The loop is the glue between coroutines and runtimes. It makes the coroutine progress while allowing runtime to process I/O.
use std::{path::PathBuf};
use io_fs::runtimes::std::handle;
use io_vdir::coroutines::list_collections::{ListCollections, ListCollectionsResult};
let mut arg = None;
let mut coroutine = ListCollections::new("/path/to/collections");
let collections = loop {
match coroutine.resume(arg) {
ListCollectionsResult::Ok(collections) => break collections,
ListCollectionsResult::Err(err) => panic!("{err}"),
ListCollectionsResult::Io(io) => arg = Some(handle(io).unwrap()),
}
};
println!("Collection paths:");
for collection in collections {
println!(" - {}", collection.path.display());
}See complete examples at ./examples.
Have a look at projects built on the top of this library:
- io-addressbook: Set of I/O-free Rust coroutines and clients to manage contacts.
- Cardamum: CLI to manage contacts.
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:
