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 › Io › Dispatch › fileReadStreaming Private Function fileReadStreaming Doc Source Private Function std.Io.Dispatch.fileReadStreaming
fn fileReadStreaming (ev : *Evented , file : File , data : []const []u8 ) File .ReadStreamingError !usize Params File Io/Dispatch.zig: 1720
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749 fn fileReadStreaming (ev : *Evented , file : File , data : []const []u8 ) File .ReadStreamingError !usize {
if (file .flags .nonblocking ) nonblocking : {
return fileReadStreamingLimit (file .handle , data , .unlimited ) catch |err | switch (err ) {
error .WouldBlock => break :nonblocking ,
else => |e | return e ,
};
}
const source = c .dispatch .source_create (
.READ ,
@bitCast (@as (isize , file .handle )),
.none ,
ev .queue ,
) orelse return error .SystemResources ;
source .as_object ().set_context (Thread .current ().currentFiber ());
source .set_event_handler (&Fiber .@"resume" );
ev .yield (.{ .activate = source .as_object () });
const limit = source .get_data ();
source .as_object ().release ();
while (true ) return fileReadStreamingLimit (
file .handle ,
data ,
.limited (limit ),
) catch |err | switch (err ) {
error .WouldBlock => {
ev .yield (.nothing );
continue ;
},
else => |e | return e ,
};
}