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 library itself.

sleep

Waits until a specified amount of time has passed on clock.

See also:

Clock.Duration.sleep
Clock.Timestamp.wait
Timeout.sleep

Io.sleep

pub fn sleep(io: Io, duration: Duration, clock: Clock) Cancelable!void

File

lib/std/Io.zig:2478

Code

pub fn sleep(io: Io, duration: Duration, clock: Clock) Cancelable!void {
    return io.vtable.sleep(io.userdata, .{ .duration = .{
        .raw = duration,
        .clock = clock,
    } });
}