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. Private Union

Result

Private Union
std.debug.StackIterator.Result
const Result = union(enum)

Fields

frame: usize

A stack frame has been found; this is the corresponding return address.

end: end

The end of the stack has been reached.

switch_to_fp: struct { address: usize, err: SelfInfoError, }

We were using SelfInfo.UnwindInfo, but are now switching to FP unwinding due to this error.

File

debug.zig:1073
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
    const Result = union(enum) {
        /// A stack frame has been found; this is the corresponding return address.
        frame: usize,
        /// The end of the stack has been reached.
        end,
        /// We were using `SelfInfo.UnwindInfo`, but are now switching to FP unwinding due to this error.
        switch_to_fp: struct {
            address: usize,
            err: SelfInfoError,
        },
    }