Struct io_uring::UringQueue

pub struct UringQueue { /* fields omitted */ }

UringQueue provides safe access to io_uring features.

Methods

impl UringQueue

pub fn new(queue_depth: u32) -> Result<Self, Error>

Create a new UringQueue with a fixed queue depth.

pub fn register_eventfd(&mut self, efd: RawFd) -> Result<(), Error>

Register an eventfd with the underlying io_uring to be notified when there's a pending completion in the queue.

pub fn prepare_read(
    &mut self,
    fd: RawFd,
    buf: &mut [u8],
    offset: i64,
    cookie: u64
) -> Result<(), Error>

Prepare and queue a request for reading from fd, starting at offset, and storing the result in buf. cookie is an arbitrary u64 value that can be used to keep track of the request.

pub fn prepare_write(
    &mut self,
    fd: RawFd,
    buf: &[u8],
    offset: i64,
    cookie: u64
) -> Result<(), Error>

Prepare and queue a request for writing the contents of buf to fd, starting at offset. cookie is an arbitrary u64 value that can be used to keep track of the request.

pub fn submit_requests(&mut self) -> Result<(), Error>

Notify the kernel that there are pending requests in the queue.

pub fn get_completion(&mut self, wait: bool) -> Result<Option<u64>, Error>

Check the completion queue and, if there's completion available to be retrieved, process it and return the u64 value specified as cookie in the request.

If there are no completions available in the queue and wait is true, keep waiting until there's a completion available, otherwise return None.

Trait Implementations

impl Drop for UringQueue

fn drop(&mut self)

Executes the destructor for this type.