tokio-uring-xitca 0.2.0

a fork of tokio-uring with miniaml maintenance
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

//! Buffers pre-registered with the kernel.
//!
//! This module provides facilities for registering in-memory buffers with
//! the `tokio-uring` runtime. Operations like [`File::read_fixed_at`][rfa] and
//! [`File::write_fixed_at`][wfa] make use of buffers pre-mapped by
//! the kernel to reduce per-I/O overhead.
//!
//! Two kinds of buffer collections are provided: [`FixedBufRegistry`] and
//! [`FixedBufPool`], realizing two different patterns of buffer management.
//! The `register` method on either of these types is used to register a
//! collection of buffers with the kernel. It must be called before any of
//! the [`FixedBuf`] handles to the collection's buffers can be used with
//! I/O operations.
//!
//! [rfa]: crate::fs::File::read_fixed_at
//! [wfa]: crate::fs::File::write_fixed_at

mod handle;
pub use handle::FixedBuf;

mod buffers;
pub(crate) use buffers::FixedBuffers;

mod plumbing;

pub mod pool;
pub use pool::FixedBufPool;

mod registry;
pub use registry::FixedBufRegistry;