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 › llvm › Builder › metadataTupleOptionalsAssumeCapacity Private Function metadataTupleOptionalsAssumeCapacity Doc Source Private Function std.zig.llvm.Builder.metadataTupleOptionalsAssumeCapacity
fn metadataTupleOptionalsAssumeCapacity (self : *Builder , elements : []const Metadata .Optional ) Metadata Params File zig/llvm/Builder.zig: 14333
14333
14334
14335
14336
14337
14338
14339
14340
14341
14342
14343
14344
14345
14346
14347
14348
14349
14350
14351
14352
14353
14354
14355
14356
14357
14358
14359
14360
14361
14362
14363
14364
14365
14366
14367
14368
14369
14370
14371
14372
14373
14374 fn metadataTupleOptionalsAssumeCapacity (self : *Builder , elements : []const Metadata .Optional ) Metadata {
const Key = struct {
elements : []const Metadata .Optional ,
};
const Adapter = struct {
builder : *const Builder ,
pub fn hash (_ : @This (), key : Key ) u32 {
var hasher = comptime std .hash .Wyhash .init (std .hash .int (@backingInt (Metadata .Tag .tuple )));
hasher .update (std .mem .sliceAsBytes (key .elements ));
return @truncate (hasher .final ());
}
pub fn eql (ctx : @This (), lhs_key : Key , _ : void , rhs_index : usize ) bool {
if (Metadata .Tag .tuple != ctx .builder .metadata_items .items (.tag )[rhs_index ]) return false ;
const rhs_data = ctx .builder .metadata_items .items (.data )[rhs_index ];
var rhs_extra = ctx .builder .metadataExtraDataTrail (Metadata .Tuple , rhs_data );
return std .mem .eql (
Metadata .Optional ,
lhs_key .elements ,
rhs_extra .trail .next (rhs_extra .data .elements_len , Metadata .Optional , ctx .builder ),
);
}
};
const gop = self .metadata_map .getOrPutAssumeCapacityAdapted (
Key { .elements = elements },
Adapter { .builder = self },
);
if (!gop .found_existing ) {
gop .key_ptr .* = {};
gop .value_ptr .* = {};
self .metadata_items .appendAssumeCapacity (.{
.tag = .tuple ,
.data = self .addMetadataExtraAssumeCapacity (Metadata .Tuple {
.elements_len = @intCast (elements .len ),
}),
});
self .metadata_extra .appendSliceAssumeCapacity (@ptrCast (elements ));
}
return .{ .index = @intCast (gop .index ), .kind = .node };
}