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 › testing › ReaderIndirect Public Struct ReaderIndirect Doc Source Public Struct std.testing.ReaderIndirect
pub const ReaderIndirect = struct Fields in : *Io .Reader interface : Io .Reader Functions File testing.zig: 1306
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362 pub const ReaderIndirect = struct {
in : *Io .Reader ,
interface : Io .Reader ,
pub fn init (in : *Io .Reader , buffer : []u8 ) ReaderIndirect {
return .{
.in = in ,
.interface = .{
.vtable = &.{
.stream = stream ,
.readVec = readVec ,
},
.buffer = buffer ,
.seek = 0 ,
.end = 0 ,
},
};
}
fn readVec (r : *Io .Reader , _ : [][]u8 ) Io .Reader .Error !usize {
try streamInner (r );
return 0 ;
}
fn stream (r : *Io .Reader , _ : *Io .Writer , _ : Io .Limit ) Io .Reader .StreamError !usize {
try streamInner (r );
return 0 ;
}
fn streamInner (r : *Io .Reader ) Io .Reader .Error !void {
const r_indirect : *ReaderIndirect = @alignCast (@fieldParentPtr ("interface" , r ));
// If there's no room remaining in the buffer at all, make room.
if (r .buffer .len == r .end ) {
try r .rebase (r .buffer .len );
}
var writer : Io .Writer = .{
.buffer = r .buffer ,
.end = r .end ,
.vtable = &.{
.drain = Io .Writer .unreachableDrain ,
.rebase = Io .Writer .unreachableRebase ,
},
};
defer r .end = writer .end ;
r_indirect .in .streamExact (&writer , r .buffer .len - r .end ) catch |err | switch (err ) {
// Only forward EndOfStream if no new bytes were written to the buffer
error .EndOfStream => |e | if (r .end == writer .end ) {
return e ;
},
error .WriteFailed => unreachable ,
else => |e | return e ,
};
}
}
A
Io.Readerthat gets its data from anotherIo.Reader, and always writes to its own buffer (and returns 0) duringstreamandreadVec.