Zig 0.17.0-dev (Split by item)

This is an example of documentation generated by ZigDoc, an alternative to Zig's built-in Auto Doc feature. See also examples in other modes/formats. The project being documented here (as the example) is the Zig library itself.

read_fixed

Queues (but does not submit) an SQE to perform a IORING_OP_READ_FIXED. The buffer provided must be registered with the kernel by calling register_buffers first. The buffer_index must be the same as its index in the array provided to register_buffers.

Returns a pointer to the SQE so that you can further modify the SQE for advanced use cases.

IoUring.read_fixed

pub fn read_fixed(
    self: *IoUring,
    user_data: u64,
    fd: linux.fd_t,
    buffer: *posix.iovec,
    offset: u64,
    buffer_index: u16,
) !*linux.io_uring_sqe

File

lib/std/os/linux/IoUring.zig:455

Code

pub fn read_fixed(
    self: *IoUring,
    user_data: u64,
    fd: linux.fd_t,
    buffer: *posix.iovec,
    offset: u64,
    buffer_index: u16,
) !*linux.io_uring_sqe {
    const sqe = try self.get_sqe();
    sqe.prep_read_fixed(fd, buffer, offset, buffer_index);
    sqe.user_data = user_data;
    return sqe;
}