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.

isValidAlignGeneric

Returns whether alignment is a valid alignment, meaning it is a positive power of 2.

mem.isValidAlignGeneric

pub fn isValidAlignGeneric(comptime T: type, alignment: T) bool

File

lib/std/mem.zig:4906

Code

pub fn isValidAlignGeneric(comptime T: type, alignment: T) bool {
    return alignment > 0 and std.math.isPowerOfTwo(alignment);
}