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.

get_probe

Returns a io_uring_probe which is used to probe the capabilities of the io_uring subsystem of the running kernel. The io_uring_probe contains the list of supported operations.

IoUring.get_probe
pub fn get_probe(self: *IoUring) !linux.io_uring_probe

File

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

Code

pub fn get_probe(self: *IoUring) !linux.io_uring_probe {
    var probe = std.mem.zeroInit(linux.io_uring_probe, .{});
    const res = linux.io_uring_register(self.fd, .REGISTER_PROBE, &probe, probe.ops.len);
    try handle_register_buf_ring_result(res);
    return probe;
}