Zig 0.17.0-dev (Split by item)

Shortcut keys
?
Show these tips
S
Focus search field
Esc
Clear focus & close tips
U
Jump to source code
↑
Move up in search results
↓
Move down in search results
↵
Go to active search result
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

readStreaming

Public Function
std.Io.File.readStreaming
pub fn readStreaming(file: File, io: Io, buffer: []const []u8) ReadStreamingError!usize

May return fewer bytes than buffer space available, including 0. End-of-stream is indicated by error.EndOfStream.

See also:

Params

  • file: File
  • io: Io
  • buffer: []const []u8

File

Io/File.zig:471
471
472
473
474
475
476
pub fn readStreaming(file: File, io: Io, buffer: []const []u8) ReadStreamingError!usize {
    return (try io.operate(.{ .file_read_streaming = .{
        .file = file,
        .data = buffer,
    } })).file_read_streaming;
}