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.

regNative

SelfUnwinder.regNative

pub fn regNative(ctx: *std.debug.cpu_context.Native, num: u16) error

File

lib/std/debug/Dwarf/SelfUnwinder.zig:297

Code

pub fn regNative(ctx: *std.debug.cpu_context.Native, num: u16) error{
    InvalidRegister,
    UnsupportedRegister,
    IncompatibleRegisterSize,
}!*align(1) std.debug.cpu_context.Native.Gpr {
    const bytes = try ctx.dwarfRegisterBytes(num);
    if (bytes.len != @sizeOf(std.debug.cpu_context.Native.Gpr)) return error.IncompatibleRegisterSize;
    return @ptrCast(bytes);
}