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 Struct

Item

Public Struct
std.zig.Zir.Inst.CompileErrors.Item
pub const Item = struct

Trailing: note_payload_index: u32 for each notes_len. It's a payload index of another Item.

Fields

msg: NullTerminatedString

null terminated string index

node: Ast.Node.OptionalIndex
token: Ast.OptionalTokenIndex

If node is .none then this will be populated.

byte_offset: u32

Can be used in combination with token.

notes: u32

0 or a payload index of a Block, each is a payload index of another Item.

Functions

pub fn notesLen(item: Item, zir: Zir) u32

File

zig/Zir.zig:3959
3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
        pub const Item = struct {
            /// null terminated string index
            msg: NullTerminatedString,
            node: Ast.Node.OptionalIndex,
            /// If node is .none then this will be populated.
            token: Ast.OptionalTokenIndex,
            /// Can be used in combination with `token`.
            byte_offset: u32,
            /// 0 or a payload index of a `Block`, each is a payload
            /// index of another `Item`.
            notes: u32,

            pub fn notesLen(item: Item, zir: Zir) u32 {
                if (item.notes == 0) return 0;
                const block = zir.extraData(Block, item.notes);
                return block.data.body_len;
            }
        }