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

writeBytePreserve

Public Function
std.Io.Writer.writeBytePreserve
pub fn writeBytePreserve(w: *Writer, preserve: usize, byte: u8) Error!void

On success, at least preserve bytes will remain buffered if there are enough buffered bytes to do so. The amount buffered by the writer after the call will only be less than preserve if w.end + 1 is less than preserve before the call. The intentionally preserved bytes will include up to preserve -| 1 bytes from the previously buffered bytes, plus the newly written byte.

Asserts buffer capacity is at least preserve.

Params

  • w: *Writer
  • preserve: usize
  • byte: u8

Errors

WriteFailed

See the Writer implementation for detailed diagnostics.

File

Io/Writer.zig:847
847
848
849
850
851
852
853
854
pub fn writeBytePreserve(w: *Writer, preserve: usize, byte: u8) Error!void {
    if (w.buffer.len - w.end == 0) {
        @branchHint(.unlikely);
        try w.vtable.rebase(w, preserve -| 1, 1);
    }
    w.buffer[w.end] = byte;
    w.end += 1;
}