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. Public Function
Without advancing the seek position, does exactly one underlying read, filling the buffer as much as possible. This may result in zero bytes added to the buffer, which is not an end of stream condition. End of stream is communicated via returning error.EndOfStream.
Without advancing the seek position, does exactly one underlying read, filling the buffer as much as possible. This may result in zero bytes added to the buffer, which is not an end of stream condition. End of stream is communicated via returning
error.EndOfStream.Asserts buffer capacity is at least 1.