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 › Uring › dirCreateFile Private Function dirCreateFile Doc Source Private Function std.Io.Uring.dirCreateFile
fn dirCreateFile (
userdata : ?*anyopaque ,
dir : Dir ,
sub_path : []const u8 ,
flags : Dir .CreateFileOptions ,
) File .OpenError !File Params userdata : ?*anyopaque dir : Dir sub_path : []const u8 flags : Dir .CreateFileOptions File Io/Uring.zig: 2830
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866 fn dirCreateFile (
userdata : ?*anyopaque ,
dir : Dir ,
sub_path : []const u8 ,
flags : Dir .CreateFileOptions ,
) File .OpenError !File {
const ev : *Evented = @ptrCast (@alignCast (userdata ));
var path_buffer : [PATH_MAX ]u8 = undefined ;
const sub_path_posix = try pathToPosix (sub_path , &path_buffer );
var maybe_sync : CancelRegion .Sync .Maybe = .{ .cancel_region = .init () };
defer maybe_sync .deinit (ev );
const fd = ev .openat (&maybe_sync .cancel_region , dir .handle , sub_path_posix , .{
.ACCMODE = if (flags .read ) .RDWR else .WRONLY ,
.CREAT = true ,
.TRUNC = flags .truncate ,
.EXCL = flags .exclusive ,
.CLOEXEC = true ,
}, flags .permissions .toMode ()) catch |err | switch (err ) {
error .OperationUnsupported => return error .Unexpected , // TMPFILE unset.
else => |e | return e ,
};
errdefer ev .closeAsync (fd );
switch (flags .lock ) {
.none => {},
.shared , .exclusive => try ev .flock (
try maybe_sync .enterSync (ev ),
fd ,
flags .lock ,
if (flags .lock_nonblocking ) .nonblocking else .blocking ,
),
}
return .{ .handle = fd , .flags = .{ .nonblocking = false } };
}