compio

Crates.iocompio
lib.rscompio
version0.10.0
sourcesrc
created_at2023-08-29 15:33:37.658484
updated_at2024-04-25 12:22:03.112433
descriptionCompletion based async runtime
homepage
repositoryhttps://github.com/compio-rs/compio
max_upload_size
id958245
size98,201
王宇逸 (Berrysoft)

documentation

README

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-propose 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 public 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.10.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.

Commit count: 1096

cargo fmt