Zig 0.17.0-dev (Split by item)

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 library itself.

writableSlicePreserve

Asserts the provided buffer has total capacity enough for len and preserve combined.

Advances the buffer end position by len.

When draining the buffer, ensures that at least preserve bytes remain buffered.

If preserve is zero, this is equivalent to writableSlice.

Writer.writableSlicePreserve

pub fn writableSlicePreserve(w: *Writer, preserve: usize, len: usize) Error![]u8

File

lib/std/Io/Writer.zig:429

Code

pub fn writableSlicePreserve(w: *Writer, preserve: usize, len: usize) Error![]u8 {
    const big_slice = try w.writableSliceGreedyPreserve(preserve, len);
    advance(w, len);
    return big_slice[0..len];
}