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.

assertAligned

Invokes detectable illegal behavior when the provided array is not aligned to the provided amount.

debug.assertAligned

pub fn assertAligned(ptr: anytype, comptime alignment: std.mem.Alignment) void

File

lib/std/debug.zig:446

Code

pub fn assertAligned(ptr: anytype, comptime alignment: std.mem.Alignment) void {
    const aligned_ptr: *align(alignment.toByteUnits()) const anyopaque = @ptrCast(@alignCast(ptr));
    _ = aligned_ptr;
}