Compio

A thread-per-core Rust runtime with IOCP/io_uring/polling. The name comes from “completion-based IO”. This crate is inspired by monoio.

Why not Tokio?

Tokio is a great generic-purpose async runtime. However, it is poll-based, and even uses undocumented APIs on Windows. We would like some new high-level APIs to perform IOCP/io_uring.

compio isn’t Tokio-based. This is mainly because that no public APIs to control IOCP in mio, and tokio won’t expose APIs to control mio before mio reaches 1.0.

Why not monoio?

Monoio focuses on Linux and io-uring, and fallbacks to mio on other platforms.

Why not glommio?

It doesn’t support Windows.

Quick start

Add compio as dependency:

compio = { version = "0.16.0", features = ["macros"] }

Then we can use high level APIs to perform filesystem & net IO.

use compio::{fs::File, io::AsyncReadAtExt};

#[compio::main]
async fn main() {
let file = File::open("Cargo.toml").await.unwrap();
let (read, buffer) = file.read_to_end_at(Vec::with_capacity(1024), 0).await.unwrap();
assert_eq!(read, buffer.len());
let buffer = String::from_utf8(buffer).unwrap();
println!("{}", buffer);
}

You can also control the low-level driver manually. See driver example of the repo.

Contributing

There are opportunities to contribute to Compio at any level. It doesn’t matter if you are just getting started with Rust or are the most weathered expert, we can use your help. If you have any question about Compio, feel free to join our telegram group. Before contributing, please checkout our contributing guide.