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.

tokenizeSequence

Returns an iterator that iterates over the slices of buffer that are not the sequence in delimiter.

tokenizeSequence(u8, "<>abc><def<><>ghi", "<>") will return slices for "abc><def", "ghi", null, in that order.

If buffer is empty, the iterator will return null. If delimiter does not exist in buffer, the iterator will return buffer, null, in that order. The delimiter length must not be zero.

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

mem.tokenizeSequence

pub fn tokenizeSequence(comptime T: type, buffer: []const T, delimiter: []const T) TokenIterator(T, .sequence)

File

lib/std/mem.zig:2416

Code

pub fn tokenizeSequence(comptime T: type, buffer: []const T, delimiter: []const T) TokenIterator(T, .sequence) {
    assert(delimiter.len != 0);
    return .{
        .index = 0,
        .buffer = buffer,
        .delimiter = delimiter,
    };
}