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

sleep

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

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

See also:

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

Params

Errors

Canceled

Caller has requested the async operation to stop.

File

Io.zig:2591
2591
2592
2593
2594
2595
2596
pub fn sleep(io: Io, duration: Duration, clock: Clock) Cancelable!void {
    return io.vtable.sleep(io.userdata, .{ .duration = .{
        .raw = duration,
        .clock = clock,
    } });
}