StrIterPeekNext

Description

Peek one position ahead in the iteration direction, i.e. the character the cursor would land on after one StrIterNext step. IterPeekAt already scales the offset by dir, so this passes a plain +1 and stays direction-correct for both forward and reverse iters.

Parameters

Success

*out is set to the next character; the cursor is not advanced; returns true.

Failure

That position is outside [0, length); *out is not written, returns false.

Usage example (Cross-references)

        StrIter si = StrIterFromZstr("abc");
        char    c  = 0;
        if (!StrIterPeekNext(&si, &c) || c != 'b') {
            return false;
        }

        StrIterMustNext(&si); // -> 'b' (last)
        char c = 0x7F;
        if (StrIterPeekNext(&si, &c)) {
            return false;
        }