mirror/zig
1
0
Fork 0
mirror of https://github.com/ziglang/zig.git synced 2026-01-21 06:45:24 +00:00
Code Issues Packages Projects Releases Wiki Activity

Improves the comment formatting.

Browse Source
This commit is contained in:
Felix "xq" Queißner 2022-08-23 15:25:27 +02:00
parent e28f4a1d85
commit 108b3c5673
2 changed files with 10 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
lib/std/heap.zig
View File

@ -29,7 +29,6 @@ pub const MemoryPoolOptions = memory_pool.Options;
/// TODO Utilize this on Windows.
pub var next_mmap_addr_hint: ?[*]align(mem.page_size) u8 = null;
const CAllocator = struct {
comptime {
if (!builtin.link_libc) {

22
lib/std/heap/memory_pool.zig
View File

@ -5,15 +5,15 @@ const debug_mode = @import("builtin").mode == .Debug;
pub const MemoryPoolError = error{OutOfMemory};
/// A memory pool that can allocate objects of a single type very quickly.
/// Use this instead of a general purpose allocator when you need to allocate a lot of objects
/// of the same type, as a memory pool outperforms general purpose allocators.
/// Use this when you need to allocate a lot of objects of the same type,
/// because It outperforms general purpose allocators.
pub fn MemoryPool(comptime Item: type) type {
return MemoryPoolAligned(Item, @alignOf(Item));
}
/// A memory pool that can allocate objects of a single type very quickly.
/// Use this instead of a general purpose allocator when you need to allocate a lot of objects
/// of the same type, as a memory pool outperforms general purpose allocators.
/// Use this when you need to allocate a lot of objects of the same type,
/// because It outperforms general purpose allocators.
pub fn MemoryPoolAligned(comptime Item: type, comptime alignment: u29) type {
if (@alignOf(Item) == alignment) {
return MemoryPoolExtra(Item, .{});
@ -32,20 +32,18 @@ pub const Options = struct {
};
/// A memory pool that can allocate objects of a single type very quickly.
/// Use this instead of a general purpose allocator when you need to allocate a lot of objects
/// of the same type, as a memory pool outperforms general purpose allocators.
/// Use this when you need to allocate a lot of objects of the same type,
/// because It outperforms general purpose allocators.
pub fn MemoryPoolExtra(comptime Item: type, comptime pool_options: Options) type {
return struct {
const Pool = @This();
/// Size of the memory pool items. This is not necessarily
/// the same as `@sizeOf(Item)` as the pool also uses the items for internal
/// means.
/// Size of the memory pool items. This is not necessarily the same
/// as `@sizeOf(Item)` as the pool also uses the items for internal means.
pub const item_size = std.math.max(@sizeOf(Node), @sizeOf(Item));
/// Alignment of the memory pool items. This is not necessarily
/// the same as `@alignOf(Item)` as the pool also uses the items for internal
/// means.
/// Alignment of the memory pool items. This is not necessarily the same
/// as `@alignOf(Item)` as the pool also uses the items for internal means.
pub const item_alignment = std.math.max(@alignOf(Node), pool_options.alignment orelse 0);
const Node = struct {