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 › WipFunction › extractElement Public Function extractElement Doc Source Public Function std.zig.llvm.Builder.WipFunction.extractElement
pub fn extractElement (
self : *WipFunction ,
val : Value ,
index : Value ,
name : []const u8 ,
) Allocator .Error !Value Params File zig/llvm/Builder.zig: 6651
6651
6652
6653
6654
6655
6656
6657
6658
6659
6660
6661
6662
6663
6664
6665
6666
6667
6668 pub fn extractElement (
self : *WipFunction ,
val : Value ,
index : Value ,
name : []const u8 ,
) Allocator .Error !Value {
assert (val .typeOfWip (self ).isVector (self .builder ));
assert (index .typeOfWip (self ).isInteger (self .builder ));
try self .ensureUnusedExtraCapacity (1 , Instruction .ExtractElement , 0 );
const instruction = try self .addInst (name , .{
.tag = .extractelement ,
.data = self .addExtraAssumeCapacity (Instruction .ExtractElement {
.val = val ,
.index = index ,
}),
});
return instruction .toValue ();
}