Struct RingConfig 

pub struct RingConfig {
    pub queue_depth: u32,
    pub fallback_threads: usize,
    pub completion_batch: usize,
    pub backend: BackendPreference,
    pub default_timeout: Option<Duration>,
    pub sq_poll_idle_ms: Option<u32>,
    pub registered_buffers: Option<RegisteredBufferConfig>,
}

Configuration for a crate::Ring.

Fields

queue_depth: u32

Maximum in-flight operations.

fallback_threads: usize

Worker threads for the fallback backend.

completion_batch: usize

Completion batch size for drain strategies.

backend: BackendPreference

Backend selection policy.

default_timeout: Option<Duration>

Optional default timeout for blocking waits.

sq_poll_idle_ms: Option<u32>

Enable IORING_SETUP_SQPOLL - the kernel polls the submission queue from a dedicated kernel thread, eliminating the submit syscall entirely.

The value is the idle timeout in milliseconds: the kernel thread spins for this long after the last submission before sleeping. A typical value is 2000 (2 seconds).

Requires Linux 5.11+ (unprivileged SQPOLL was added in 5.19).

registered_buffers: Option<RegisteredBufferConfig>

Pre-register a pool of kernel-pinned buffers for zero-copy I/O.

When set, the native Linux io_uring backend uses this count and size with IORING_REGISTER_BUFFERS. When unset, that backend still registers a default pool (32 buffers of 4096 bytes each) so fixed-buffer machinery is always available unless registration fails during setup.

Implementations

impl RingConfig

pub fn with_queue_depth(self, queue_depth: u32) -> Self

Returns a copy with the provided queue depth.

pub fn with_backend(self, backend: BackendPreference) -> Self

Returns a copy with the provided backend policy.

pub fn with_fallback_threads(self, fallback_threads: usize) -> Self

Returns a copy with the provided fallback thread count.

pub fn with_completion_batch(self, completion_batch: usize) -> Self

Returns a copy with the provided completion batch size.

pub fn with_default_timeout(self, default_timeout: Option<Duration>) -> Self

Returns a copy with the provided default timeout.

pub fn with_sq_poll(self, idle_ms: u32) -> Self

Enables IORING_SETUP_SQPOLL with the given idle timeout in milliseconds.

When active, the kernel polls the submission queue from a dedicated thread, eliminating the io_uring_enter syscall for submissions. The kernel thread sleeps after idle_ms milliseconds of inactivity.

pub fn with_registered_buffers(self, count: u32, size: u32) -> Self

Enables pre-registered kernel-pinned buffers.

The ring allocates count buffers of size bytes and registers them with the kernel at creation time. I/O operations using these buffers bypass per-operation page pinning overhead.

pub fn validate(&self) -> Result<()>

Validates the configuration.

Trait Implementations

impl Clone for RingConfig

fn clone(&self) -> RingConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RingConfig

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

Formats the value using the given formatter.

impl Default for RingConfig

fn default() -> Self

Returns the “default value” for a type.

impl Eq for RingConfig

impl PartialEq for RingConfig

fn eq(&self, other: &RingConfig) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for RingConfig