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.

splitScalar

Returns an iterator that iterates over the slices of buffer that are separated by delimiter.

splitScalar(u8, "abc|def||ghi", '|') will return slices for "abc", "def", "", "ghi", null, in that order.

If delimiter does not exist in buffer, the iterator will return buffer, null, in that order.

See also: splitSequence, splitAny, splitBackwardsSequence, splitBackwardsAny,splitBackwardsScalar, tokenizeAny, tokenizeSequence, and tokenizeScalar.

mem.splitScalar

pub fn splitScalar(comptime T: type, buffer: []const T, delimiter: T) SplitIterator(T, .scalar)

File

lib/std/mem.zig:2633

Code

pub fn splitScalar(comptime T: type, buffer: []const T, delimiter: T) SplitIterator(T, .scalar) {
    return .{
        .index = 0,
        .buffer = buffer,
        .delimiter = delimiter,
    };
}