Method Iterator()->_iterator_next()

Method _iterator_next

protected mixed _iterator_next()

Description

This function advances the iterator one step.

Note

This is the only function that is required in the Pike 9.0 and later iterator API. Presence of this function indicates that the iterator implements the Pike 9.0 API.

Returns

Returns UNDEFINED if there are no more values in the set of elements. If [_iterator_value()] is implemented, 0 (zero) may also be returned if there are no more values. Any other value may be returned if it succeeded in advancing to a new element. The returned value is used as the result for _iterator_index() and _iterator_value() if they are not implemented.

See also

_iterator_prev(), lfun::_iterator_next(), iterator_next(), _iterator_index(), _iterator_value()