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

write

Public Function
std.Io.Writer.write
pub fn write(w: *Writer, bytes: []const u8) Error!usize

Transfers bytes to the stream, calling drain at most once.

Returns the number of bytes transferred, which may be less than bytes.len, including zero.

A return value less than bytes.len does not indicate failure; a subsequent call may return nonzero, or fail with error.WriteFailed.

See also:

Params

Errors

WriteFailed

See the Writer implementation for detailed diagnostics.

File

Io/Writer.zig:608
608
609
610
611
612
613
614
615
616
pub fn write(w: *Writer, bytes: []const u8) Error!usize {
    if (w.end + bytes.len <= w.buffer.len) {
        @branchHint(.likely);
        @memcpy(w.buffer[w.end..][0..bytes.len], bytes);
        w.end += bytes.len;
        return bytes.len;
    }
    return w.vtable.drain(w, &.{bytes}, 1);
}