Zig 0.17.0-dev (Split by item)

?

× Shortcut keys

?: Show these tips

S: Focus search field

Esc: Clear focus & close tips

U: Jump to source code

↑: Move up in search results

↓: Move down in search results

↵: Go to active search result

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. Private Function

status

Doc Source

Private Function

std.Io.Threaded.Group.status

fn status(g: Group) *std.atomic.Value(Status)

Returns a correctly-typed pointer to the Io.Group.token field.

The status indicates how many pending tasks are in the group, whether the group has been canceled, and whether the group has been awaited.

Note that the zero value of Status intentionally represents the initial group state (empty with no awaiters). This is a requirement of Io.Group.

Params

g: Group

File

Io/Threaded.zig:466

466
467
468

    fn status(g: Group) *std.atomic.Value(Status) {
        return @ptrCast(&g.ptr.token);
    }