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 › debug › Coverage › String Public Enum String Doc Source Public Enum std.debug.Coverage.String
pub const String = enum (u32 ) Structs File debug/Coverage.zig: 36
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67 pub const String = enum (u32 ) {
_ ,
pub const MapContext = struct {
string_bytes : []const u8 ,
pub fn eql (self : @This (), a : String , b : String , b_index : usize ) bool {
_ = b_index ;
const a_slice = span (self .string_bytes [@backingInt (a )..]);
const b_slice = span (self .string_bytes [@backingInt (b )..]);
return std .mem .eql (u8 , a_slice , b_slice );
}
pub fn hash (self : @This (), a : String ) u32 {
return @truncate (Hash .hash (0 , span (self .string_bytes [@backingInt (a )..])));
}
};
pub const SliceAdapter = struct {
string_bytes : []const u8 ,
pub fn eql (self : @This (), a_slice : []const u8 , b : String , b_index : usize ) bool {
_ = b_index ;
const b_slice = span (self .string_bytes [@backingInt (b )..]);
return std .mem .eql (u8 , a_slice , b_slice );
}
pub fn hash (self : @This (), a : []const u8 ) u32 {
_ = self ;
return @truncate (Hash .hash (0 , a ));
}
};
}