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 › File Public Struct File Doc Source Public Struct std.debug.Coverage.File
pub const File = extern struct Fields directory_index : u32 basename : String Structs Types File debug/Coverage.zig: 81
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127 pub const File = extern struct {
directory_index : u32 ,
basename : String ,
pub const Index = enum (u32 ) {
invalid = std .math .maxInt (u32 ),
_ ,
};
pub const MapContext = struct {
string_bytes : []const u8 ,
pub fn hash (self : MapContext , a : File ) u32 {
const a_basename = span (self .string_bytes [@backingInt (a .basename )..]);
return @truncate (Hash .hash (a .directory_index , a_basename ));
}
pub fn eql (self : MapContext , a : File , b : File , b_index : usize ) bool {
_ = b_index ;
if (a .directory_index != b .directory_index ) return false ;
const a_basename = span (self .string_bytes [@backingInt (a .basename )..]);
const b_basename = span (self .string_bytes [@backingInt (b .basename )..]);
return std .mem .eql (u8 , a_basename , b_basename );
}
};
pub const SliceAdapter = struct {
string_bytes : []const u8 ,
pub const Entry = struct {
directory_index : u32 ,
basename : []const u8 ,
};
pub fn hash (self : @This (), a : Entry ) u32 {
_ = self ;
return @truncate (Hash .hash (a .directory_index , a .basename ));
}
pub fn eql (self : @This (), a : Entry , b : File , b_index : usize ) bool {
_ = b_index ;
if (a .directory_index != b .directory_index ) return false ;
const b_basename = span (self .string_bytes [@backingInt (b .basename )..]);
return std .mem .eql (u8 , a .basename , b_basename );
}
};
}