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 standard library.
std › zig › ErrorBundle › Wip › toOwnedBundle Public Function toOwnedBundle Doc Source Public Function std.zig.ErrorBundle.Wip.toOwnedBundle
pub fn toOwnedBundle (wip : *Wip , compile_log_text : []const u8 ) !ErrorBundle Params wip : *Wip compile_log_text : []const u8 File zig/ErrorBundle.zig: 371
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409 pub fn toOwnedBundle (wip : *Wip , compile_log_text : []const u8 ) !ErrorBundle {
const gpa = wip .gpa ;
if (wip .root_list .items .len == 0 ) {
assert (compile_log_text .len == 0 );
// Special encoding when there are no errors.
wip .deinit ();
wip .* = .{
.gpa = gpa ,
.string_bytes = .empty ,
.extra = .empty ,
.root_list = .empty ,
};
return empty ;
}
const compile_log_str_index = if (compile_log_text .len == 0 ) 0 else str : {
const str : u32 = @intCast (wip .string_bytes .items .len );
try wip .string_bytes .ensureUnusedCapacity (gpa , compile_log_text .len + 1 );
wip .string_bytes .appendSliceAssumeCapacity (compile_log_text );
wip .string_bytes .appendAssumeCapacity (0 );
break :str str ;
};
wip .setExtra (0 , ErrorMessageList {
.len = @intCast (wip .root_list .items .len ),
.start = @intCast (wip .extra .items .len ),
.compile_log_text = compile_log_str_index ,
});
try wip .extra .appendSlice (gpa , @as ([]const u32 , @ptrCast (wip .root_list .items )));
wip .root_list .clearAndFree (gpa );
try wip .string_bytes .shrinkToLen (gpa );
try wip .extra .shrinkToLen (gpa );
return .{
.string_bytes = wip .string_bytes .toOwnedSliceAssert (),
.extra = wip .extra .toOwnedSliceAssert (),
};
}