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 › Threaded › fileHardLink Private Function fileHardLink Doc Source Private Function std.Io.Threaded.fileHardLink
fn fileHardLink (
userdata : ?*anyopaque ,
file : File ,
new_dir : Dir ,
new_sub_path : []const u8 ,
options : File .HardLinkOptions ,
) File .HardLinkError !void Params userdata : ?*anyopaque file : File new_dir : Dir new_sub_path : []const u8 options : File .HardLinkOptions File Io/Threaded.zig: 7136
7136
7137
7138
7139
7140
7141
7142
7143
7144
7145
7146
7147
7148
7149
7150
7151
7152
7153
7154
7155
7156
7157
7158
7159
7160
7161
7162
7163
7164 fn fileHardLink (
userdata : ?*anyopaque ,
file : File ,
new_dir : Dir ,
new_sub_path : []const u8 ,
options : File .HardLinkOptions ,
) File .HardLinkError !void {
_ = userdata ;
if (native_os != .linux ) return error .OperationUnsupported ;
var new_path_buffer : [posix .PATH_MAX ]u8 = undefined ;
const new_sub_path_posix = try pathToPosix (new_sub_path , &new_path_buffer );
const flags : u32 = if (options .follow_symlinks )
posix .AT .SYMLINK_FOLLOW | posix .AT .EMPTY_PATH
else
posix .AT .EMPTY_PATH ;
return linkat (file .handle , "" , new_dir .handle , new_sub_path_posix , flags ) catch |err | switch (err ) {
error .FileNotFound => {
if (options .follow_symlinks ) return error .FileNotFound ;
var proc_buf : ["/proc/self/fd/-2147483648\x00" .len ]u8 = undefined ;
const proc_path = std .mem .printSentinel (&proc_buf , "/proc/self/fd/{d}" , .{file .handle }, 0 ) catch
unreachable ;
return linkat (posix .AT .FDCWD , proc_path , new_dir .handle , new_sub_path_posix , posix .AT .SYMLINK_FOLLOW );
},
else => |e | return e ,
};
}