I/O Filesystem

Set of I/O-free Rust coroutines and runtimes to manage filesystems.

This library allows you to manage filesystems 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

Read a directory synchronously

use std::{path::PathBuf};

use io_fs::{coroutines::read_dir::ReadDir, error::FsResult, runtimes::std::handle};

let mut arg = None;
let mut coroutine = ReadDir::new("/tmp");

let paths = loop {
    match coroutine.resume(arg) {
        FsResult::Ok(paths) => break paths,
        FsResult::Err(err) => panic!("{err}"),
        FsResult::Io(io) => arg = Some(handle(io).unwrap()),
    }
};

println!("Entries inside {}:", path.display());

for path in paths {
    println!(" - {}", path.display());
}

See complete examples at ./examples.

More examples

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

io-vdir: Set of I/O-free Rust coroutines to manage Vdir filesystems.
io-addressbook: Set of I/O-free Rust coroutines and clients to manage contacts.
Cardamum: CLI to manage contacts.

License

This project is licensed under either of:

at your option.

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:

io-fs 0.0.1