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 › mem › lenSliceTo Private Function lenSliceTo Doc Source Private Function std.mem.lenSliceTo
fn lenSliceTo (ptr : anytype , comptime end : std .meta .Elem (@TypeOf (ptr ))) usize Params File mem.zig: 1037
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080 fn lenSliceTo (ptr : anytype , comptime end : std .meta .Elem (@TypeOf (ptr ))) usize {
switch (@typeInfo (@TypeOf (ptr ))) {
.pointer => |ptr_info | switch (ptr_info .size ) {
.one => switch (@typeInfo (ptr_info .child )) {
.array => |array_info | {
if (array_info .sentinel ()) |s | {
if (s == end ) {
return findSentinel (array_info .child , end , ptr );
}
}
return findScalar (array_info .child , ptr , end ) orelse array_info .len ;
},
else => {},
},
.many => if (ptr_info .sentinel ()) |s | {
if (s == end ) {
return findSentinel (ptr_info .child , end , ptr );
}
// We're looking for something other than the sentinel,
// but iterating past the sentinel would be a bug so we need
// to check for both.
var i : usize = 0 ;
while (ptr [i ] != end and ptr [i ] != s ) i += 1 ;
return i ;
} else {
return findSentinel (ptr_info .child , end , @ptrCast (ptr ));
},
.c => {
assert (ptr != null );
return findSentinel (ptr_info .child , end , ptr );
},
.slice => {
if (ptr_info .sentinel ()) |s | {
if (s == end ) {
return findSentinel (ptr_info .child , s , ptr );
}
}
return findScalar (ptr_info .child , ptr , end ) orelse ptr .len ;
},
},
else => {},
}
@compileError ("invalid type given to std.mem.sliceTo: " ++ @typeName (@TypeOf (ptr )));
}
Private helper for sliceTo(). If you want the length, use sliceTo(foo, x).len