fiox 0.2.0

file I/O using io_uring/iocp
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60


# fiox


![Build Status](https://github.com/keithyin/fiox/actions/workflows/rust.yml/badge.svg)
[![Crates.io](https://img.shields.io/crates/v/fiox.svg)](https://crates.io/crates/fiox)

> **Zero-Copy, Asynchronous File I/O for Rust — powered by io_uring on Linux and IOCP on Windows, with built-in ring buffer support.**


fiox delivers **ultra-low-latency, high-throughput file I/O** by leveraging modern kernel interfaces:
- **Linux**: Direct `io_uring` integration (bypassing traditional syscall overhead)
- **Windows**: Native `I/O Completion Ports` (IOCP) for scalable async I/O

Paired with efficient **ring buffers**, RingIO enables seamless zero-copy data pipelines 

---

## ✨ Features

- ✅ **Cross-platform**: Linux (io_uring) & Windows (IOCP)  
- ✅ **Zero-copy reads/writes** using direct io  
- ✅ Built-in **SPSC ring buffers** for high-speed data staging  
- ✅ Batching & coalescing for reduced syscalls  



### SequentialReader

``` rust

let read_start_pos = 10;
let mut reader =
    SequentialReader::new("test_data/test_data.txt", read_start_pos, 4096, 2).unwrap();


let buf_size = 112560;
let mut buf = vec![0_u8; buf_size];
let mut read_size = 0;
loop {
    let n = reader.read2buf(&mut buf).unwrap();
    if n == 0 {
        break;
    }
    print!("{}", String::from_utf8((&buf[..n]).to_vec()).unwrap());
}
```

### SequentialWriter

```rust
    
let mut writer =
    SequentialWriter::new("test_data/test_data_writer.txt", 0, 4096, 2).unwrap();
for i in 0..1000 {
    writer
        .write(format!("line:{}, abcdefghijklmnopqrstuvwxyz\n", i).as_bytes())
        .unwrap();
}
```