Struct rio::Config

pub struct Config {
    pub depth: usize,
    pub sq_poll: bool,
    pub sq_poll_affinity: u32,
    pub io_poll: bool,
    pub print_profile_on_drop: bool,
    pub raw_params: Option<io_uring_params>,
}

Configuration for the underlying io_uring system.

Fields

depth: usize

The number of entries in the submission queue. The completion queue size may be specified by using raw_params instead. By default, the kernel will choose a completion queue that is 2x the submission queue's size.

sq_poll: bool

Enable SQPOLL mode, which spawns a kernel thread that polls for submissions without needing to block as often to submit.

This is a privileged operation, and will cause start to fail if run by a non-privileged user.

sq_poll_affinity: u32

Specify a particular CPU to pin the SQPOLL thread onto.

io_poll: bool

Specify that the user will directly poll the hardware for operation completion rather than using the completion queue.

CURRENTLY UNSUPPORTED

print_profile_on_drop: bool

Print a profile table on drop, showing where time was spent.

raw_params: Option<io_uring_params>

setting raw_params overrides everything else

Methods

impl Config

pub fn start(self) -> Result<Rio>

Start the Rio system.

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for Config

impl Debug for Config

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

Formats the value using the given formatter.

impl Default for Config

fn default() -> Config

Returns the "default value" for a type.