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

OptionalTokenIndex

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

Index into tokens, or null.

Functions

pub fn unwrap(oti: OptionalTokenIndex) ?TokenIndex
pub fn fromToken(ti: TokenIndex) OptionalTokenIndex
pub fn fromOptional(oti: ?TokenIndex) OptionalTokenIndex

File

zig/Ast.zig:39
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
pub const OptionalTokenIndex = enum(u32) {
    none = std.math.maxInt(u32),
    _,

    pub fn unwrap(oti: OptionalTokenIndex) ?TokenIndex {
        return if (oti == .none) null else @backingInt(oti);
    }

    pub fn fromToken(ti: TokenIndex) OptionalTokenIndex {
        return @fromBackingInt(@intCast(ti));
    }

    pub fn fromOptional(oti: ?TokenIndex) OptionalTokenIndex {
        return if (oti) |ti| @fromBackingInt(@intCast(ti)) else .none;
    }
}