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 › streamInner Private Function streamInner Doc Source Private Function std.testing.ReaderIndirect.streamInner
fn streamInner (r : *Io .Reader ) Io .Reader .Error !void Params File testing.zig: 1335
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 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 ,
};
}