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

checkCancel

Doc Source

Private Function

std.Io.Threaded.Syscall.checkCancel

fn checkCancel(s: Syscall) Io.Cancelable!void

Checks whether this syscall has been canceled. This should be called when a syscall is interrupted through a mechanism which may indicate cancelation, or may be spurious. If the syscall was canceled, it is finished and error.Canceled is returned. Otherwise, the syscall is not marked finished, and the caller should retry.

Params

s: Syscall

File

Io/Threaded.zig:1373

    fn checkCancel(s: Syscall) Io.Cancelable!void {
        const thread = s.thread orelse return;
        switch (thread.status.fetchOr(.{
            .cancelation = @fromBackingInt(@intCast(0b010)),
            .awaitable = .null,
        }, .monotonic).cancelation) {
            .none => unreachable,
            .parked => unreachable,
            .blocked_alertable => unreachable,
            .blocked_alertable_canceling => unreachable,
            .canceling => unreachable,
            .canceled => unreachable,
            .blocked => {}, // new status is `.blocked` (unchanged)
            .blocked_canceling => return error.Canceled, // new status is `.canceled`
        }
    }