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

read

Public Function
std.Io.net.Stream.read
pub fn read(s: *const Stream, io: Io, data: [][]u8) Reader.Error!usize

This is a low-level API that calls the Io interface function directly. For a higher level API, see reader.

Params

File

Io/net.zig:1274
1274
1275
1276
1277
1278
1279
    pub fn read(s: *const Stream, io: Io, data: [][]u8) Reader.Error!usize {
        return (try io.operate(.{ .net_read = .{
            .socket_handle = s.socket.handle,
            .data = data,
        } })).net_read;
    }