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

peekDelimiterExclusive

Public Function
std.Io.Reader.peekDelimiterExclusive
pub fn peekDelimiterExclusive(r: *Reader, delimiter: u8) DelimiterError![]u8

Returns a slice of the next bytes of buffered data from the stream until delimiter is found, without advancing the seek position.

Returned slice excludes the delimiter. End-of-stream is treated equivalent to a delimiter, unless it would result in a length 0 return value, in which case error.EndOfStream is returned instead.

If the delimiter is not found within a number of bytes matching the capacity of this Reader, error.StreamTooLong is returned. In such case, the stream state is unmodified as if this function was never called.

Invalidates previously returned values from peek.

See also:

Params

Errors

ReadFailed

See the Reader implementation for detailed diagnostics.

EndOfStream

For "inclusive" functions, stream ended before the delimiter was found. For "exclusive" functions, stream ended and there are no more bytes to return.

StreamTooLong

The delimiter was not found within a number of bytes matching the capacity of the Reader.

File

Io/Reader.zig:930
930
931
932
933
934
935
936
937
938
939
940
pub fn peekDelimiterExclusive(r: *Reader, delimiter: u8) DelimiterError![]u8 {
    const result = r.peekDelimiterInclusive(delimiter) catch |err| switch (err) {
        error.EndOfStream => {
            const remaining = r.buffer[r.seek..r.end];
            if (remaining.len == 0) return error.EndOfStream;
            return remaining;
        },
        else => |e| return e,
    };
    return result[0 .. result.len - 1];
}