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

writeSplatHeaderLimit

Public Function
std.Io.Writer.writeSplatHeaderLimit
pub fn writeSplatHeaderLimit(
    w: *Writer,
    header: []const u8,
    data: []const []const u8,
    splat: usize,
    limit: Limit,
) Error!usize

Equivalent to writeSplatHeader but writes at most limit bytes.

Params

  • w: *Writer
  • header: []const u8
  • data: []const []const u8
  • splat: usize
  • limit: Limit

Errors

WriteFailed

See the Writer implementation for detailed diagnostics.

File

Io/Writer.zig:216
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
pub fn writeSplatHeaderLimit(
    w: *Writer,
    header: []const u8,
    data: []const []const u8,
    splat: usize,
    limit: Limit,
) Error!usize {
    var remaining = @backingInt(limit);
    assert(data.len > 0);
    {
        const copy_len = @min(header.len, remaining);
        if (w.buffer.len - w.end < copy_len) return try writeSplatHeaderLimitFinish(w, header, data, splat, remaining);
        @memcpy(w.buffer[w.end..][0..copy_len], header[0..copy_len]);
        w.end += copy_len;
        remaining -= copy_len;
    }

    remaining_zero: {
        if (remaining == 0) break :remaining_zero;
        for (data[0 .. data.len - 1], 0..) |bytes, i| {
            const copy_len = @min(bytes.len, remaining);
            if (w.buffer.len - w.end < copy_len) {
                const n = try writeSplatHeaderLimitFinish(w, &.{}, data[i..], splat, remaining);
                return @backingInt(limit) - remaining + n;
            }
            @memcpy(w.buffer[w.end..][0..copy_len], bytes[0..copy_len]);
            w.end += copy_len;
            remaining -= copy_len;
        }

        if (remaining == 0) break :remaining_zero;
        const pattern = data[data.len - 1];
        for (0..splat) |i| {
            const copy_len = @min(pattern.len, remaining);
            if (w.buffer.len - w.end < copy_len) {
                const remaining_splat = splat - i;
                const n = try writeSplatHeaderLimitFinish(w, &.{}, data[data.len - 1 ..][0..1], remaining_splat, remaining);
                return @backingInt(limit) - remaining + n;
            }
            @memcpy(w.buffer[w.end..][0..copy_len], pattern[0..copy_len]);
            w.end += copy_len;
            remaining -= copy_len;
        }
    }

    return @backingInt(limit) - remaining;
}