Library / Strings / Bytes / ByteBufferIterator
ByteBufferIterator
Value-form iterator over a ByteBuffer.
Constructors 2
INIT(REFERENCE binary[] source, int64 start, int64 length)
BORROWING form — built by ByteBuffer.iterator() and
DynamicByteBuffer.iterator(), which pass their own binary[] FIELD
plus the window [start, start+length). The iterator ALIASES that
storage, so the argument must outlive the iterator. Both owners pass the
whole array (0, .data.length).
INIT(binary[] snapshot)
OWNING form — the iterator takes the array and lends itself the borrow.
.data =@ .owned is SELF-rooted, so the referent lives exactly as long
as the iterator does and the dangle cannot arise. This is the
form ByteBufferView.iterator() uses.
It is separable from the borrowing form ONLY because their arities
differ. Two one-argument constructors over the same EvArray<uint8_t>,
one owning and one REFERENCE, lower to by-value and const-reference
and clang rejects the pair as ambiguous — which is what blocked
ByteBufferView.iterator() through Phase 1.
Methods 5
METHOD hasNext() RETURNS booleanreads
MODIFY METHOD nextValue() RETURNS | binarymodifies
Value-form advance — copy out the byte at the cursor, then step the cursor forward. FAILURE at end-of-iteration.
METHOD peekValue() RETURNS | binaryreads
The byte at the cursor without advancing. FAILURE at end.
MODIFY METHOD skipValue(uint64 n) RETURNS | binarymodifies
Move the cursor forward by n and return the byte there.
FAILURE if that would pass the end. skipValue(0) == peekValue().
MODIFY METHOD nextBytes(int64 numberOfBytes) RETURNS | binary[]modifies
Block read: copy up to numberOfBytes bytes from the cursor into
a fresh binary[] and advance the cursor past them. Returns fewer
than requested when the buffer is exhausted first (the caller
checks .length); FAILURE only when the cursor is already at the
end, or numberOfBytes is not positive. The block-oriented
counterpart to byte-at-a-time nextValue(), mirroring the
(binary[] | STATUS) shape of File.read().