Zig 0.17.0-dev (Split by item)

Shortcut keys
?
Show these tips
S
Focus search field
Esc
Clear focus & close tips
U
Jump to source code
↑
Move up in search results
↓
Move down in search results
↵
Go to active search result
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 standard library. Public Type Function

Aligned

Public Type Function
std.heap.memory_pool.Aligned
pub fn Aligned(comptime Item: type, comptime alignment: Alignment) type

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.

File

heap/memory_pool.zig:12
12
13
14
pub fn Aligned(comptime Item: type, comptime alignment: Alignment) type {
    return Extra(Item, .{ .alignment = alignment });
}