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.

assertReadable

Invokes detectable illegal behavior when the provided slice is not mapped or lacks read permissions.

debug.assertReadable

pub fn assertReadable(slice: []const volatile u8) void

File

lib/std/debug.zig:439

Code

pub fn assertReadable(slice: []const volatile u8) void {
    if (!runtime_safety) return;
    for (slice) |*byte| _ = byte.*;
}