Struct UringIoEngineConfig 

pub struct UringIoEngineConfig { /* private fields */ }

Config for io_uring based I/O engine.

Implementations

impl UringIoEngineConfig

pub fn new() -> Self

Create a new io_uring based I/O engine config with default configurations.

pub fn with_threads(self, threads: usize) -> Self

Set the number of threads to use for the I/O engine.

pub fn with_cpus(self, cpus: Vec<u32>) -> Self

Bind the engine threads to specific CPUs.

The length of cpus must be equal to the threads.

pub fn with_io_depth(self, io_depth: usize) -> Self

Set the I/O depth for each thread.

pub fn with_iopoll(self, iopoll: bool) -> Self

Enable or disable I/O polling.

FYI:

• io_uring_setup(2)
• crate - io-uring

Related syscall flag: IORING_SETUP_IOPOLL.

NOTE:

• If this feature is enabled, the underlying device MUST be opened with the O_DIRECT flag.
• If this feature is enabled, the underlying device MUST support io polling.

Default: false.

pub fn with_weight(self, weight: f64) -> Self

Set the weight of read/write priorities.

The engine will try to keep the read/write iodepth ratio as close to the specified weight as possible.

pub fn with_sqpoll(self, sqpoll: bool) -> Self

Enable or disable SQ polling.

FYI:

• io_uring_setup(2)
• crate - io-uring

Related syscall flag: IORING_SETUP_IOPOLL.

NOTE: If this feature is enabled, the underlying device must be opened with the O_DIRECT flag.

Default: false.

pub fn with_sqpoll_cpus(self, cpus: Vec<u32>) -> Self

Bind the kernel’s SQ poll thread to the specified cpu.

This flag is only meaningful when Self::with_sqpoll is enabled.

The length of cpus must be equal to the number of threads.

pub fn with_sqpoll_idle(self, idle: u32) -> Self

After idle milliseconds, the kernel thread will go to sleep and you will have to wake it up again with a system call.

This flag is only meaningful when Self::with_sqpoll is enabled.

Trait Implementations

impl Debug for UringIoEngineConfig

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for UringIoEngineConfig

fn default() -> Self

Returns the “default value” for a type.

impl IoEngineConfig for UringIoEngineConfig

fn build( self: Box<Self>, _: IoEngineBuildContext, ) -> BoxFuture<'static, Result<Arc<dyn IoEngine>>>

Build an I/O engine from the given configuration.

fn boxed(self) -> Box<Self>

where Self: Sized,

Box the config.