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 › windows › FILE › PIPE › WAIT_FOR_BUFFER Public Struct WAIT_FOR_BUFFER Doc Source Public Struct std.os.windows.FILE.PIPE.WAIT_FOR_BUFFER
pub const WAIT_FOR_BUFFER = extern struct Fields Values Functions File os/windows.zig: 373
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403 pub const WAIT_FOR_BUFFER = extern struct {
Timeout : LARGE_INTEGER ,
NameLength : ULONG ,
TimeoutSpecified : BOOLEAN ,
Name : [PATH_MAX_WIDE ]WCHAR ,
pub const WAIT_FOREVER : LARGE_INTEGER = std .math .minInt (LARGE_INTEGER );
pub fn init (opts : struct {
Timeout : ?LARGE_INTEGER = null ,
Name : []const WCHAR ,
}) WAIT_FOR_BUFFER {
var fpwfb : WAIT_FOR_BUFFER = .{
.Timeout = opts .Timeout orelse undefined ,
.NameLength = @intCast (@sizeOf (WCHAR ) * opts .Name .len ),
.TimeoutSpecified = @intFromBool (opts .Timeout != null ),
.Name = undefined ,
};
@memcpy (fpwfb .Name [0 ..opts .Name .len ], opts .Name );
return fpwfb ;
}
pub fn getName (fpwfb : *const WAIT_FOR_BUFFER ) []const WCHAR {
return fpwfb .Name [0 ..@divExact (fpwfb .NameLength , @sizeOf (WCHAR ))];
}
pub fn toBuffer (fpwfb : *const WAIT_FOR_BUFFER ) []const u8 {
const start : [*]const u8 = @ptrCast (fpwfb );
return start [0 .. @offsetOf (WAIT_FOR_BUFFER , "Name" ) + fpwfb .NameLength ];
}
}