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 Enum

OptionalIndex

Public Enum
std.zig.Ast.Node.OptionalIndex
pub const OptionalIndex = enum(u32)

Index into nodes, or null.

Functions

pub fn unwrap(oi: OptionalIndex) ?Index
pub fn fromOptional(oi: ?Index) OptionalIndex

File

zig/Ast.zig:2938
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
    pub const OptionalIndex = enum(u32) {
        root = 0,
        none = std.math.maxInt(u32),
        _,

        pub fn unwrap(oi: OptionalIndex) ?Index {
            return if (oi == .none) null else @fromBackingInt(@intCast(@backingInt(oi)));
        }

        pub fn fromOptional(oi: ?Index) OptionalIndex {
            return if (oi) |i| i.toOptional() else .none;
        }
    }