8 releases (4 breaking)

0.5.0 Nov 21, 2024
0.4.1 Sep 24, 2024
0.3.0 Jun 17, 2024
0.2.0 Apr 25, 2024
0.1.0-beta.1 Nov 17, 2023

#1858 in Asynchronous

Download history 401/week @ 2024-08-12 619/week @ 2024-08-19 750/week @ 2024-08-26 512/week @ 2024-09-02 440/week @ 2024-09-09 593/week @ 2024-09-16 1529/week @ 2024-09-23 674/week @ 2024-09-30 514/week @ 2024-10-07 846/week @ 2024-10-14 506/week @ 2024-10-21 637/week @ 2024-10-28 875/week @ 2024-11-04 1108/week @ 2024-11-11 1376/week @ 2024-11-18 681/week @ 2024-11-25

4,112 downloads per month
Used in 16 crates (9 directly)

MIT license

125KB
2.5K SLoC


Compio

MIT licensed crates.io docs.rs Check Test Telegram

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.

Unlike tokio-uring, this runtime 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/tokio-uring/glommio?

They don't support Windows.

Quick start

Add compio as dependency:

compio = { version = "0.12.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.

Dependencies

~0.6–1MB
~17K SLoC