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 › renameat Public Function renameat Doc Source Public Function std.os.linux.IoUring.renameat
pub fn renameat (
self : *IoUring ,
user_data : u64 ,
old_dir_fd : linux .fd_t ,
old_path : [*:0 ]const u8 ,
new_dir_fd : linux .fd_t ,
new_path : [*:0 ]const u8 ,
flags : u32 ,
) !*linux .io_uring_sqe Params self : *IoUring user_data : u64 old_dir_fd : linux .fd_t old_path : [*:0 ]const u8 new_dir_fd : linux .fd_t new_path : [*:0 ]const u8 flags : u32 File os/linux/IoUring.zig: 1015
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028 pub fn renameat (
self : *IoUring ,
user_data : u64 ,
old_dir_fd : linux .fd_t ,
old_path : [*:0 ]const u8 ,
new_dir_fd : linux .fd_t ,
new_path : [*:0 ]const u8 ,
flags : u32 ,
) !*linux .io_uring_sqe {
const sqe = try self .get_sqe ();
sqe .prep_renameat (old_dir_fd , old_path , new_dir_fd , new_path , flags );
sqe .user_data = user_data ;
return sqe ;
}
Queues (but does not submit) an SQE to perform a
renameat2(2). Returns a pointer to the SQE.