A base class to simplify implementing iterators so that implementations only have to implement computeNext to implement the iterator, calling done when the iteration is complete.

AbstractIterator()

Computes the next item in the iterator.

abstract fun computeNext()

Sets the state to done so that the iteration terminates.

fun done()

Returns true if the iteration has more elements.

open fun hasNext(): Boolean

Returns the next element in the iteration.

open fun next(): T

Sets the next value in the iteration, called from the computeNext function

fun setNext(value: T)

Creates a sequence that returns all elements from this iterator. The sequence is constrained to be iterated only once.

fun <T> Iterator<T>.asSequence(): Sequence<T>

Performs the given operation on each element of this Iterator.

fun <T> Iterator<T>.forEach(operation: (T) -> Unit)

Returns the given iterator itself. This allows to use an instance of iterator in a for loop.

operator fun <T> Iterator<T>.iterator(): Iterator<T>

Returns an Iterator wrapping each value produced by this Iterator with the IndexedValue, containing value and it's index.

fun <T> Iterator<T>.withIndex(): Iterator<IndexedValue<T>>