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

Note

Public Struct
std.zig.Zoir.CompileError.Note
pub const Note = extern struct

Fields

msg: NullTerminatedString
token: Ast.OptionalTokenIndex
node_or_offset: u32

If token == .none, this is an Ast.Node.Index. Otherwise, this is a byte offset into token.

File

zig/Zoir.zig:251
251
252
253
254
255
256
257
    pub const Note = extern struct {
        msg: NullTerminatedString,
        token: Ast.OptionalTokenIndex,
        /// If `token == .none`, this is an `Ast.Node.Index`.
        /// Otherwise, this is a byte offset into `token`.
        node_or_offset: u32,
    }