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.

nop

Queues (but does not submit) an SQE to perform a no-op. Returns a pointer to the SQE so that you can further modify the SQE for advanced use cases. A no-op is more useful than may appear at first glance. For example, you could call drain_previous_sqes() on the returned SQE, to use the no-op to know when the ring is idle before acting on a kill signal.

IoUring.nop

pub fn nop(self: *IoUring, user_data: u64) !*linux.io_uring_sqe

File

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

Code

pub fn nop(self: *IoUring, user_data: u64) !*linux.io_uring_sqe {
    const sqe = try self.get_sqe();
    sqe.prep_nop();
    sqe.user_data = user_data;
    return sqe;
}