4 releases (breaking)

0.3.0 Mar 4, 2022
0.2.0 Jan 9, 2022
0.1.0 Jul 19, 2021
0.0.0 Nov 14, 2020

#257 in Asynchronous

Download history 171/week @ 2022-03-11 431/week @ 2022-03-18 518/week @ 2022-03-25 302/week @ 2022-04-01 199/week @ 2022-04-08 471/week @ 2022-04-15 426/week @ 2022-04-22 575/week @ 2022-04-29 314/week @ 2022-05-06 383/week @ 2022-05-13 434/week @ 2022-05-20 437/week @ 2022-05-27 1000/week @ 2022-06-03 952/week @ 2022-06-10 716/week @ 2022-06-17 1093/week @ 2022-06-24

3,864 downloads per month
Used in 6 crates (5 directly)

MIT license

100KB
1.5K SLoC

tokio-uring

This crate provides io-uring for Tokio by exposing a new Runtime that is compatible with Tokio but also can drive io-uring-backed resources. Any library that works with Tokio also works with tokio-uring. The crate provides new resource types that work with io-uring.

API Docs | Chat

Getting started

Using tokio-uring requires starting a [tokio-uring] runtime. This runtime internally manages the main Tokio runtime and a io-uring driver.

use tokio_uring::fs::File;

fn main() -> Result<(), Box<dyn std::error::Error>> {
    tokio_uring::start(async {
        // Open a file
        let file = File::open("hello.txt").await?;

        let buf = vec![0; 4096];
        // Read some data, the buffer is passed by ownership and
        // submitted to the kernel. When the operation completes,
        // we get the buffer back.
        let (res, buf) = file.read_at(buf, 0).await;
        let n = res?;

        // Display the contents
        println!("{:?}", &buf[..n]);

        Ok(())
    })
}

Requirements

tokio-uring requires a very recent linux kernel. (Not even all kernels with io_uring support will work) In particular 5.4.0 does not work (This is standard on Ubuntu 20.4). However 5.11.0 (the ubuntu hwe image) does work.

Project status

The tokio-uring project is still very young. Currently, we are focusing on supporting filesystem and network operations. Eventually, we will add safe APIs for all io-uring compatible operations.

License

This project is licensed under the MIT license.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in tokio-uring by you, shall be licensed as MIT, without any additional terms or conditions.

Dependencies

~2.5–8MB
~124K SLoC