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.

alignForwardOrOom

SafeAllocator.alignForwardOrOom

fn alignForwardOrOom(a: Alignment, addr: usize) error

File

lib/std/heap/SafeAllocator.zig:774

Code

fn alignForwardOrOom(a: Alignment, addr: usize) error{OutOfMemory}!usize {
    const x = a.toByteUnits() - 1;
    return try addOrOom(addr, x) & ~x;
}