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 standard library.
std › os › linux › IoUring › recv Public Function recv Doc Source Public Function std.os.linux.IoUring.recv
pub fn recv (
self : *IoUring ,
user_data : u64 ,
fd : linux .fd_t ,
buffer : RecvBuffer ,
flags : u32 ,
) !*linux .io_uring_sqe Params File os/linux/IoUring.zig: 633
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652 pub fn recv (
self : *IoUring ,
user_data : u64 ,
fd : linux .fd_t ,
buffer : RecvBuffer ,
flags : u32 ,
) !*linux .io_uring_sqe {
const sqe = try self .get_sqe ();
switch (buffer ) {
.buffer => |slice | sqe .prep_recv (fd , slice , flags ),
.buffer_selection => |selection | {
sqe .prep_rw (.RECV , fd , 0 , selection .len , 0 );
sqe .rw_flags = flags ;
sqe .flags |= linux .IOSQE_BUFFER_SELECT ;
sqe .buf_index = selection .group_id ;
},
}
sqe .user_data = user_data ;
return sqe ;
}
Queues (but does not submit) an SQE to perform a
recv(2). Returns a pointer to the SQE. Available since 5.6