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 standard library.
std › zig › AstGen › offsetOf Private Function offsetOf Doc Source Private Function std.zig.AstGen.offsetOf
fn offsetOf (
gz : *GenZir ,
scope : *Scope ,
ri : ResultInfo ,
node : Ast .Node .Index ,
lhs_node : Ast .Node .Index ,
rhs_node : Ast .Node .Index ,
tag : Zir .Inst .Tag ,
) InnerError !Zir .Inst .Ref Params Errors File zig/AstGen.zig: 9916
9916
9917
9918
9919
9920
9921
9922
9923
9924
9925
9926
9927
9928
9929
9930
9931
9932 fn offsetOf (
gz : *GenZir ,
scope : *Scope ,
ri : ResultInfo ,
node : Ast .Node .Index ,
lhs_node : Ast .Node .Index ,
rhs_node : Ast .Node .Index ,
tag : Zir .Inst .Tag ,
) InnerError !Zir .Inst .Ref {
const type_inst = try typeExpr (gz , scope , lhs_node );
const field_name = try comptimeExpr (gz , scope , .{ .rl = .{ .coerced_ty = .slice_const_u8_type } }, rhs_node , .field_name );
const result = try gz .addPlNode (tag , node , Zir .Inst .Bin {
.lhs = type_inst ,
.rhs = field_name ,
});
return rvalue (gz , ri , result , node );
}