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 › Build › Cache › Path › openDir Public Function openDir Doc Source Public Function std.Build.Cache.Path.openDir
pub fn openDir (
p : Path ,
io : Io ,
sub_path : []const u8 ,
args : Io .Dir .OpenOptions ,
) Io .Dir .OpenError !Io .Dir Params p : Path io : Io sub_path : []const u8 args : Io .Dir .OpenOptions File Build/Cache/Path.zig: 71
71
72
73
74
75
76
77
78
79
80
81
82
83
84 pub fn openDir (
p : Path ,
io : Io ,
sub_path : []const u8 ,
args : Io .Dir .OpenOptions ,
) Io .Dir .OpenError !Io .Dir {
var buf : [Io .Dir .max_path_bytes ]u8 = undefined ;
const joined_path = if (p .sub_path .len == 0 ) sub_path else p : {
break :p std .mem .print (&buf , "{s}" ++ Io .Dir .path .sep_str ++ "{s}" , .{
p .sub_path , sub_path ,
}) catch return error .NameTooLong ;
};
return p .root_dir .handle .openDir (io , joined_path , args );
}