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.

list

The Slice is not backed by a MultiArrayList, so calling deinit or toMultiArrayList is illegal.

TokenSmith.list

pub fn list(t: *TokenSmith) TokenList.Slice

File

lib/std/zig/TokenSmith.zig:244

Code

pub fn list(t: *TokenSmith) TokenList.Slice {
    var slice: TokenList.Slice = .{
        .ptrs = undefined,
        .len = t.tags_len,
        .capacity = t.tags_len,
    };
    comptime std.debug.assert(slice.ptrs.len == 2);
    slice.ptrs[@backingInt(TokenList.Field.tag)] = @ptrCast(&t.tag_buf);
    slice.ptrs[@backingInt(TokenList.Field.start)] = @ptrCast(&t.start_buf);
    return slice;
}