We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
1 parent 5e7ff5a commit c8bfa3dCopy full SHA for c8bfa3d
io-uring-bufring/README.md
@@ -1,3 +1,12 @@
1
# io-uring-bufring
2
3
-bufring abstraction that can be used with io-uring-bearer or io-uring directly.
+io_uring buffer ring mapping abstraction that can be used with io-uring-bearer or io-uring directly.
4
+
5
+Note that this mapped ring of buffers does not handle data itself but you will need to pair
6
+it with thing like [hugepage] or [anonymous mmap] where this crate maps the underlying memory
7
+into a buffer ring that the linux kernel understands.
8
9
+See the [bearer test](./src/ring_buf/ring_buf_test.rs) for an example.
10
11
+[hugepage]: https://github.com/yaws-rs/ylibc/tree/main/hugepage
12
+[anonymous_mmap]: https://github.com/yaws-rs/ylibc/tree/main/anonymous_mmap
0 commit comments