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 › Io › Dispatch › dirRenamePreserve Private Function dirRenamePreserve Doc Source Private Function std.Io.Dispatch.dirRenamePreserve
fn dirRenamePreserve (
userdata : ?*anyopaque ,
old_dir : Dir ,
old_sub_path : []const u8 ,
new_dir : Dir ,
new_sub_path : []const u8 ,
) Dir .RenamePreserveError !void Params userdata : ?*anyopaque old_dir : Dir old_sub_path : []const u8 new_dir : Dir new_sub_path : []const u8 File Io/Dispatch.zig: 2989
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002 fn dirRenamePreserve (
userdata : ?*anyopaque ,
old_dir : Dir ,
old_sub_path : []const u8 ,
new_dir : Dir ,
new_sub_path : []const u8 ,
) Dir .RenamePreserveError !void {
const ev : *Evented = @ptrCast (@alignCast (userdata ));
// Make a hard link then delete the original.
try dirHardLink (ev , old_dir , old_sub_path , new_dir , new_sub_path , .{ .follow_symlinks = false });
const prev = swapCancelProtection (ev , .blocked );
defer _ = swapCancelProtection (ev , prev );
dirDeleteFile (ev , old_dir , old_sub_path ) catch {};
}