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 › Futex › Waker Private Struct Waker Doc Source Private Struct std.Io.Dispatch.Futex.Waker
const Waker = struct Fields sleeper : Sleeper = undefined futex : *Futex ptr : *const u32 max_waiters : u32 Functions fn remove (context : ?*anyopaque ) callconv (.c ) void File Io/Dispatch.zig: 1576
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608 const Waker = struct {
sleeper : Sleeper = undefined ,
futex : *Futex ,
ptr : *const u32 ,
max_waiters : u32 ,
fn remove (context : ?*anyopaque ) callconv (.c ) void {
const waker : *Waker = @ptrCast (@alignCast (context ));
const futex = waker .futex ;
const ptr = waker .ptr ;
const max_waiters = waker .max_waiters ;
var num_removed : usize = 0 ;
var next_node = futex .waiters .first ;
while (num_removed < max_waiters ) {
const waiter : *Waiter = @fieldParentPtr ("node" , next_node orelse break );
next_node = waiter .node .next ;
if (waiter .ptr != ptr ) {
@branchHint (.unlikely );
continue ;
}
waiter .tryRemove () catch |err | switch (err ) {
error .CancelRequested => continue ,
};
num_removed += 1 ;
}
assert (@atomicRmw (usize , &futex .num_waiters , .Sub , num_removed , .monotonic ) >= num_removed );
var sleeper = waker .sleeper ;
waker .* = undefined ;
Sleeper .wake (&sleeper );
}
}