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.

ImportLookupTableEntry

coff.ImportLookupTableEntry

pub fn ImportLookupTableEntry(comptime magic: std.coff.OptionalHeader.Magic) type

File

lib/std/coff.zig:428

Code

pub fn ImportLookupTableEntry(comptime magic: std.coff.OptionalHeader.Magic) type {
    const Payload = packed union(u31) {
        ordinal: packed struct(u31) {
            ordinal: u16,
            _: u15 = 0,
        },
        hint_name_rva: u31,
    };

    return switch (magic) {
        _ => comptime unreachable,
        .PE32 => packed struct(u32) {
            payload: Payload,
            is_ordinal: bool,
        },
        .@"PE32+" => packed struct(u64) {
            payload: Payload,
            _: u32 = 0,
            is_ordinal: bool,
        },
    };
}