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.

Aligned

A memory pool that can allocate objects of a single type very quickly. Use this when you need to allocate a lot of objects of the same type, because it outperforms general purpose allocators. Allocated items are aligned to alignment-byte addresses or @alignOf(Item) if alignment is null. Functions that potentially allocate memory accept an Allocator parameter.

memory_pool.Aligned

pub fn Aligned(comptime Item: type, comptime alignment: Alignment) type

File

lib/std/heap/memory_pool.zig:12

Code

pub fn Aligned(comptime Item: type, comptime alignment: Alignment) type {
    return Extra(Item, .{ .alignment = alignment });
}