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 › Threaded › concurrent Private Function concurrent Doc Source Private Function std.Io.Threaded.concurrent
fn concurrent (
userdata : ?*anyopaque ,
result_len : usize ,
result_alignment : Alignment ,
context : []const u8 ,
context_alignment : Alignment ,
start : *const fn (context : *const anyopaque , result : *anyopaque ) void ,
) Io .ConcurrentError !*Io .AnyFuture Params userdata : ?*anyopaque result_len : usize result_alignment : Alignment context : []const u8 context_alignment : Alignment start : *const fn (context : *const anyopaque , result : *anyopaque ) void File Io/Threaded.zig: 2121
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165 fn concurrent (
userdata : ?*anyopaque ,
result_len : usize ,
result_alignment : Alignment ,
context : []const u8 ,
context_alignment : Alignment ,
start : *const fn (context : *const anyopaque , result : *anyopaque ) void ,
) Io .ConcurrentError !*Io .AnyFuture {
if (builtin .single_threaded ) return error .ConcurrencyUnavailable ;
const t : *Threaded = @ptrCast (@alignCast (userdata ));
const gpa = t .allocator ;
const future = Future .create (gpa , result_len , result_alignment , context , context_alignment , start ) catch |err | switch (err ) {
error .OutOfMemory => return error .ConcurrencyUnavailable ,
};
errdefer future .destroy (gpa );
mutexLock (&t .mutex );
defer mutexUnlock (&t .mutex );
const busy_count = t .busy_count ;
if (busy_count >= @backingInt (t .concurrent_limit ))
return error .ConcurrencyUnavailable ;
t .busy_count = busy_count + 1 ;
errdefer t .busy_count = busy_count ;
const pool_size = t .wait_group .value ();
if (pool_size - busy_count == 0 ) {
t .wait_group .start ();
errdefer t .wait_group .finish ();
const thread = std .Thread .spawn (.{ .stack_size = t .stack_size }, worker , .{t }) catch
return error .ConcurrencyUnavailable ;
thread .detach ();
}
t .run_queue .prepend (&future .runnable .node );
condSignal (&t .cond );
return @ptrCast (future );
}