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

FunctionDefinition

Public Struct
std.coff.FunctionDefinition
pub const FunctionDefinition = extern struct

Fields

tag_index: u32

The symbol-table index of the corresponding .bf (begin function) symbol record.

total_size: u32

The size of the executable code for the function itself. If the function is in its own section, the SizeOfRawData in the section header is greater or equal to this field, depending on alignment considerations.

pointer_to_linenumber: u32

The file offset of the first COFF line-number entry for the function, or zero if none exists.

pointer_to_next_function: u32

The symbol-table index of the record for the next function. If the function is the last in the symbol table, this field is set to zero.

unused: [2]u8

File

coff.zig:881
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
pub const FunctionDefinition = extern struct {
    /// The symbol-table index of the corresponding .bf (begin function) symbol record.
    tag_index: u32,

    /// The size of the executable code for the function itself.
    /// If the function is in its own section, the SizeOfRawData in the section header is greater or equal to this field,
    /// depending on alignment considerations.
    total_size: u32,

    /// The file offset of the first COFF line-number entry for the function, or zero if none exists.
    pointer_to_linenumber: u32,

    /// The symbol-table index of the record for the next function.
    /// If the function is the last in the symbol table, this field is set to zero.
    pointer_to_next_function: u32,

    unused: [2]u8,
}