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 › Mutex › Waiter › remove Private Function remove Doc Source Private Function std.Io.Dispatch.Mutex.Waiter.remove
fn remove (context : ?*anyopaque ) callconv (.c ) void Params File Io/Dispatch.zig: 872
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903 fn remove (context : ?*anyopaque ) callconv (.c ) void {
const mutex : *Mutex = @ptrCast (@alignCast (context ));
var state = @atomicLoad (State , &mutex .state , .monotonic );
while (!state .locked and state .num_waiters > 0 ) {
@branchHint (.likely );
state = @cmpxchgWeak (State , &mutex .state , state , .{
.locked = true ,
.num_waiters = state .num_waiters - 1 ,
}, .acquire , .monotonic ) orelse break ;
} else return ;
var num_removed : State .NumWaiters = 0 ;
while (mutex .waiters .popFirst ()) |node | {
@branchHint (.likely );
const waiter : *Waiter = @fieldParentPtr ("node" , node );
node .* = undefined ;
waiter .cancelable .leave (waiter .sleeper .fiber ) catch |err | switch (err ) {
error .CancelRequested => {
num_removed += 1 ;
node .next = node ;
continue ;
},
};
break ;
}
if (num_removed > 0 ) {
@branchHint (.unlikely );
assert (@atomicRmw (State , &mutex .state , .Sub , .{
.locked = false ,
.num_waiters = num_removed ,
}, .monotonic ).num_waiters >= num_removed );
}
}