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.

cancel

Queues (but does not submit) an SQE to remove an existing operation. Returns a pointer to the SQE.

The operation is identified by its user_data.

The completion event result will be 0 if the operation was found and canceled successfully, -EALREADY if the operation was found but was already in progress, or -ENOENT if the operation was not found.

IoUring.cancel

pub fn cancel(
    self: *IoUring,
    user_data: u64,
    cancel_user_data: u64,
    flags: u32,
) !*linux.io_uring_sqe

File

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

Code

pub fn cancel(
    self: *IoUring,
    user_data: u64,
    cancel_user_data: u64,
    flags: u32,
) !*linux.io_uring_sqe {
    const sqe = try self.get_sqe();
    sqe.prep_cancel(cancel_user_data, flags);
    sqe.user_data = user_data;
    return sqe;
}