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

Bits

Public Struct
std.zig.Zir.Inst.SwitchBlock.Bits
pub const Bits = packed struct(u32)

Fields

has_multi_cases: bool

If true, one or more prongs have multiple items.

any_ranges: bool

If true, one or more prongs have ranges. Only valid if has_multi_cases is also set.

has_else: bool
has_under: bool
has_continue: bool

If true, at least one prong contains a continue. Only valid if has_label is set.

any_maybe_runtime_capture: bool

If true, at least one prong has a non-inline payload/tag capture.

payload_capture_inst_is_placeholder: bool
tag_capture_inst_is_placeholder: bool
scalar_cases_len: ScalarCasesLen

Values

File

zig/Zir.zig:3377
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
        pub const Bits = packed struct(u32) {
            /// If true, one or more prongs have multiple items.
            has_multi_cases: bool,
            /// If true, one or more prongs have ranges.
            /// Only valid if `has_multi_cases` is also set.
            any_ranges: bool,
            has_else: bool,
            has_under: bool,
            /// If true, at least one prong contains a `continue`.
            /// Only valid if `has_label` is set.
            has_continue: bool,
            // If true, at least one prong has a non-inline payload/tag capture.
            any_maybe_runtime_capture: bool,
            payload_capture_inst_is_placeholder: bool,
            tag_capture_inst_is_placeholder: bool,
            scalar_cases_len: ScalarCasesLen,

            // NOTE maybe don't steal any more bits from poor `scalar_cases_len`
            // and split `Bits` into two parts instead, `raw_operand` surely
            // wouldn't mind donating a couple of bits for that purpose...
            pub const ScalarCasesLen = u24;
        }