InternalIterator

Since: 8.0

final class InternalIterator implements Iterator (View source)

Methods

mixed
current()

Return the current element

void
next()

Move forward to next element

mixed
key()

Return the key of the current element

bool
valid()

Check if current position is valid

void
rewind()

Rewind the Iterator to the first element

Details

at line 955
mixed current()

Return the current element

Returns the current element.

Return Value

mixed

Can return any type.

at line 965
void next()

Move forward to next element

Moves the current position to the next element.

Return Value

void

Any returned value is ignored.

at line 975
mixed key()

Return the key of the current element

Returns the key of the current element.

Return Value

mixed

TKey on success, or null on failure.

at line 985
bool valid()

Check if current position is valid

Checks if current position is valid.

Return Value

bool

The return value will be casted to boolean and then evaluated. Returns true on success or false on failure.

at line 995
void rewind()

Rewind the Iterator to the first element

Rewinds back to the first element of the Iterator.

Return Value

void

Any returned value is ignored.