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.

isAligned

Given an address and an alignment, return true if the address is a multiple of the alignment The alignment must be a power of 2 and greater than 0.

mem.isAligned

pub fn isAligned(addr: usize, alignment: usize) bool

File

lib/std/mem.zig:4929

Code

pub fn isAligned(addr: usize, alignment: usize) bool {
    return isAlignedGeneric(u64, addr, alignment);
}