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 › zon › parse › Diagnostics Public Struct Diagnostics Doc Source Public Struct std.zon.parse.Diagnostics
pub const Diagnostics = struct Fields ast : Ast = .{ .source = "" , .tokens = .empty , .nodes = .empty , .extra_data = &.{}, .mode = .zon , .errors = &.{}, } zoir : Zoir = .{ .nodes = .empty , .extra = &.{}, .limbs = &.{}, .string_bytes = &.{}, .compile_errors = &.{}, .error_notes = &.{}, } type_check : ?Error .TypeCheckFailure = null Functions File zon/parse.zig: 193
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248 pub const Diagnostics = struct {
ast : Ast = .{
.source = "" ,
.tokens = .empty ,
.nodes = .empty ,
.extra_data = &.{},
.mode = .zon ,
.errors = &.{},
},
zoir : Zoir = .{
.nodes = .empty ,
.extra = &.{},
.limbs = &.{},
.string_bytes = &.{},
.compile_errors = &.{},
.error_notes = &.{},
},
type_check : ?Error .TypeCheckFailure = null ,
fn assertEmpty (self : Diagnostics ) void {
assert (self .ast .tokens .len == 0 );
assert (self .zoir .nodes .len == 0 );
assert (self .type_check == null );
}
pub fn deinit (self : *Diagnostics , gpa : Allocator ) void {
self .ast .deinit (gpa );
self .zoir .deinit (gpa );
if (self .type_check ) |tc | tc .deinit (gpa );
self .* = undefined ;
}
pub fn iterateErrors (self : *const Diagnostics ) Error .Iterator {
return .{ .diag = self };
}
pub fn format (self : *const @This (), w : *std .Io .Writer ) std .Io .Writer .Error !void {
var errors = self .iterateErrors ();
while (errors .next ()) |err | {
const loc = err .getLocation (self );
const msg = err .fmtMessage (self );
try w .print ("{d}:{d}: error: {f}\n" , .{ loc .line + 1 , loc .column + 1 , msg });
var notes = err .iterateNotes (self );
while (notes .next ()) |note | {
const note_loc = note .getLocation (self );
const note_msg = note .fmtMessage (self );
try w .print ("{d}:{d}: note: {f}\n" , .{
note_loc .line + 1 ,
note_loc .column + 1 ,
note_msg ,
});
}
}
}
}
Information about the success or failure of a parse.