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

Offset

Public Enum
std.zig.Ast.Node.Offset
pub const Offset = enum(i32)

A relative node index.

Functions

pub fn toOptional(o: Offset) OptionalOffset
pub fn toAbsolute(offset: Offset, base: Index) Index

File

zig/Ast.zig:2953
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
    pub const Offset = enum(i32) {
        zero = 0,
        _,

        pub fn toOptional(o: Offset) OptionalOffset {
            const result: OptionalOffset = @fromBackingInt(@intCast(@backingInt(o)));
            assert(result != .none);
            return result;
        }

        pub fn toAbsolute(offset: Offset, base: Index) Index {
            return @fromBackingInt(@intCast(@as(i64, @backingInt(base)) + @backingInt(offset)));
        }
    }